JavaDoc生成文档

文档注释

/**
*
*
*
*/

例：

package com.guo.base;

/**
 * @author ChenGuo
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

    /**
     * @author ChenGuo
     * @param name
     * @return
     * @throws Exception
     */

    public String test(String name) throws Exception{
        return name;
    }
}

命令行生成JavaDoc生成文档 格式：javadoc 参数 Java文件

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

使用IDEA生成javaDoc文档

点击工具
选择生成JavaDoc
按图片操作