Java基础知识之一注释

Java基础知识之一注释

分类

Java中的注释分为三类，见下表：

类型	表示方法	说明	常用参数
单行注释	//注释内容	单行注释可以嵌套
多行注释	/*注释内容*/	多行注释之间不能嵌套，但是多行注释可以嵌套单行注释
文档注释	/**注释内容 * /	利用javadoc工具可以生成一套HTML的文档，并且文档注释只能出现在类、接口、方法、构造器、field，位置要写在这些部分的上方，写在其他的地方会出现不正确的显示，	@author（作者） @version（版本） @param（参数说明） @ruturn（返回值说明）

关于文档注释，可能有C语言编程经验的人知道，在C语言中是没有这种注释的，Java为了方便开发者查看，同时也给了Java用户一个可以参考的文档，所以java使用了所谓的文档注释，在生成文档注释是使用了javadoc.exe工具，同样在jdk的bin目录下。

javadoc工具的使用

1. “Win+R”，输入cmd，打开命令提示符；
2. 在其中输入javadoc，在我们的文档中需要的参数见图：

如果想显示类中所有的方法可以是使用-private参数等等，需要的时候请在控制台中输入：javadoc查看，并决定怎么使用.

使用举例如下：

javadoc -author -version -d F:\JAVA文档 Demo1.java

怎么写注释

关于写注释一定要养成良好的习惯，多向别人学习，在参考文献中给出几个比较好的注释方法，请参考。

参考资料：

1. http://www.cnblogs.com/boring09/p/4274893.html
2. http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#examples

联系我