JAVA文档生成

准备工作

准备需要用于生成文档的类，注意类中一定要按照可生成文档的固定格式编写，不然生成的类文档中是没有对应信息描述的。

/**
 * @author lplove
 * @version 1.0.0
 */
public class DocDemo1 {
    /**
     * 方法-说
     * @param name 名称
     * @return 说的内容
     */
    public String say(String name){
        return "hello " + name;
    }
}

/**
 * @author lplove
 * @version 1.0.0
 */
public class DocDemo2 {
    /**
     * 方法-写
     * @param name 名称
     */
    public void write(String name){
        System.out.println("write " + name);
    }
}

文档格式相关的注释说明。

@author	标识一个类的作者	@author description
@deprecated	指名一个过期的类或成员	@deprecated description
	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
	插入一个到另一个主题的链接
	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据	@serialData description
@serialField	说明一个ObjectStreamField组件	@serialField name type description
@since	标记当引入一个特定的变化时	@since release
@throws	和 @exception标签一样.	The @throws tag has the same meaning as the @exception tag.
	显示常量的值，该常量必须是static属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info

IDEA方式

1. 选择Tools-->Generate JavaDoc..

2. 设置文档范围（可单个文件活整个项目）、输出位置、其他命令等信息。

   

3. 生成文档的输出目录中，会有一个index.html文件，打开就可以看到对应的文档信息了。

   ​

命令方式

1. 打开 cmd 命令窗口，进入到需要生成类文档的路径下，执行下面的命令。

   : -d 文档存放目录
   : 可通过javadoc -help 查看相关的帮助信息
   javadoc -d docFolder -encoding UTF-8 -charset UTF-8 DocDemo2.java
   

2. 执行完成后，会在该类路径下生成对应的文档文件，打开里面的index.html文件就可以看到对应的类文档信息了。