java中文档注释怎么用_使用文档注释（javadoc）

相信作为Java程序猿,几乎每个人都使用过javac,Java这样的命令吧。想想我们平时使用的Java帮助文档(API),感觉挺好用的,其实它就是使用Java中的命令javadoc做成的.下面简单介绍一下这个命令是怎么使用的：

首先Java中用三种注释方式,要想使用javadoc生成文档并且将注释信息也添加进文档里面,就要是用这种方式:

1 /**

2 *3 */

其次就是注释信息应该放置的位置。1.对类的注释放在类申明之前;2.对方法的注释放在方法申明之前;下面举一个简单的例子:

1 packagecom.review.chapter3;2

3 /**

4 * ClassName: UseJavadoc
5 * Description: 通过UseJavadoc类说明Java中文档注释
6 * Company: zhouxy7 *@authorzhouxy8 *@version201408299 *10 */

11 public classUseJavadoc {12 publicString name;13

14 /**

15 * 这是UseJavadoc类的构造函数16 *@paramname 参数17 */

18 publicUseJavadoc(String name){19 this.name =name;20 }21

22

23 /**

24 * 这是getAll方法的说明25 *@paramnumber 数量26 *@return数量27 */

28 public int getAll(intnumber){29

30 returnnumber;31 }32 }

在上面的代码中有的注释后面加上了
标签,有的没有,是因为@符号自带一个换行符,所以使用@就不必添加
标签了.

下面就是使用javadoc命令来生成了。首先使用快捷键win+R,在对话框里面键入cmd,切换到改文件保存的目录之下,然后又一下三种方式(假设你想将生成的HTML文档保存在docDirectory目录下):

1.如果你要生成的是一个包:javadoc -d docDirectory -version -author nameOfPackage

2.如果你要生成的是多个包:javadoc -d docDirectory -version -author nameOfPackage1 nameOfPackage2.....

3.如果文件在默认包中:javadoc -d docDirectory -version - author *.java

如果省略了 -d docDirectory 那么生成的HTML文档会保存在当前目录下,这样会带来混乱,不提倡这样做。

-version -author表示要求在说明文档中加入版本信息和作者信息。nameOfPackage 表示java类所在的包名.