程序的注释和文档可以说跟代码一样非常重要，良好的注释和代码会使软件以后的维护工作变得轻松。千万不要忽视这些注释和文档，作为一个合格的软件程序员，一定要认真对待。这里简单说下关于javadoc的应用。

javadoc是随JDK一起的，专门用来将Java程序中的注释转换为类似于Java API的文档的工具。它输出html文档，用你的Web浏览器来查看。

首先，你的注释必须符合一定的格式。这里，必须在/**和*/之间。例如：

packagesrc;

/***@authorhwoarangzk*@version1.0*@since2007.02.21*/publicclassA {/***Justamethod*@paramargsAArrayListargumentsoftypeString

*/publicstaticvoidmain(String args[]) {

System.out.println("Hello world!");

}/***@returnNullNovaluereturned

*/publicintmethodTest() {return1;

}

}

也就是说，//和在/*...*/之间的注释是不会被转换为文档的。一般注释都放在类、方法和变量前面。

我们可以在注释中添加一些信息，例如作者、版本等等。它们都以@开头，放在*后面，例如以上的例子。下面介绍些常用的。

@author 作者信息:作者的信息

@version 版本信息:版本的信息

@since:指定程序代码最早使用的版本

@param 参数名称 参数描述:放在方法前面，参数名称要和参数列表中的名称相符合

@return 返回描述:描述方法返回值的信息，void方法不能使用这个注释

@throws 异常类名称 异常描述:描述方法中的异常信息

此外，还有更多其他的注释内容，可以去Sun官网查看。

在Eclipse中，如果想名称为A的类生成文档，那么，写好一个文件后(包括注释)，在左边的Package Explorer中右键单击该文件，选择Export--->Java--->Javadoc，再选择好一个输出的路径就可以finish了。然后去这个路径就能够查看到相应文档了。