美文网首页规范
如何在Java中使用注释

如何在Java中使用注释

作者: 吴迪好 | 来源:发表于2016-04-07 21:30 被阅读27次

在编写程序时,经常需要添加一些注释,用以描述某段代码的作用。

一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上。因此,注释是程序源代码的重要组成部分,一定要加以重视哦!

Java 中注释有三种类型:单行注释、多行注释、文档注释

运行结果:Hello Imooc!

看:被注释的代码块在程序运行时是不会被执行的~~

我们可以通过javadoc命令从文档注释中提取内容,生成程序的 API 帮助文档。

打开首页,查看下生成的 API 文档

PS:使用文档注释时还可以使用javadoc 标记,生成更详细的文档信息:

@author 标明开发该类模块的作者

@version 标明该类模块的版本

@see 参考转向,也就是相关主题

@param 对方法中某参数的说明

@return 对方法返回值的说明

@exception 对方法可能抛出的异常进行说明

相关文章

  • 如何在Java中使用注释

    在编写程序时,经常需要添加一些注释,用以描述某段代码的作用。 一般来说,对于一份规范的程序源代码而言,注释应该占到...

  • Java反射 - 注解

    使用Java反射,您可以在运行时访问附加到Java类的注解。 什么是Java注释? 注释是Java 5中的一项新功...

  • javaSE回顾_02

    Java中的注释 Java中的注释有三种: 1. 单行注释——//注释内容 2. 多行注释——/* ...

  • Java中的注释、关键字、标识符

    Java中的注释 1. 单行注释 // 2. 多行注释 /* */ 3. 文档注释 /** */ Java中的关键...

  • Python学习笔记

    1. 注释 python中使用'''或者"""进行文档注释,类似于java中的javadoc 2. 下划线_ _ ...

  • Groovy基本语法

    官方文档 注释(Comments) 和Java一样,支持单行(使用//)、多行(/* */)和文档注释(使用/**...

  • 3.注释(Comment)

    含义:用于注解说明解释程序的文字就是注释 1.Java中的注释类型 单行注释 多行注释 文档注释(java特有) ...

  • Java基础复习

    注释 Java语言的注释有三种 单行注释 多行注释 文档注释 CSDN中这篇文章详细描述了java文档注释的各种用...

  • 第一个java程序

    规定使用javac命令要加后缀名(xxx.java) 而java命令省略.class(xxx) 注释 单行注释//...

  • idea yml配置中显示java注释乱码

    在java的配置类中,定义的字段中注释使用中文: 但是在spring boot的yml中显示注释时是乱码: 我的i...

网友评论

    本文标题:如何在Java中使用注释

    本文链接:https://www.haomeiwen.com/subject/acqvlttx.html