1.概念

文档注释：在程序中采用特定的注释格式进行注释，然后通过JDK提供的工具javadoc来解析，生成一套以网页文件形式体现的程序说明文档。

文档注释，一般用于注释类或方法。

2. 简单使用演示

演示程序DocComment.java：

/**
	* @author 小明
	* @version 1.0
*/


public class DocComment{

    public static void main(String[] args){
        System.out.println("hello,world~");
    }
}

javadoc工具的命令通用格式：

javadoc -d 存储所生成注释文档的路径 -标签 -标签 xxx.java

针对DocComment.java的javadoc工具的命令：

javadoc -d E:\CW-JavaCode\project_001\DocComment -author -version DocComment.java

执行效果：

E:\CW-JavaCode\project_001\DocComment路径下所生成的文档：

通过浏览器打开其中的index.html：

3. Java的文档注释的基本格式

/**
	* @标签名 xxx
	* @标签名 xxx
*/

4. javadoc的常用标签