Java基础系列（14）- JavaDoc生成文档

2024-09-06 16:28:42

JavaDoc

JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API，易读且清晰明了

参数信息

@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

官方的帮助文档如图，我们自己项目的帮助文档通过javadoc也可以弄成这样

code

package base;

/**

 * 类的注释

 * @author Gelaotou

 * @version 1.0

 * @since 1.8

 */

public class doc {

    String name;

    /**

     * 方法的注释

     * @author Gelaotou

     * @param name

     * @return

     * @throws Exception

     */

    public String test(String name) throws Exception{

        return name;

    }

}

使用Intellij Idea生成JavaDoc文档

step-1 Generate JavaDoc

step-2 配置

选择是整个项目还是模块还是单个文件
文档输出路径
Locale 选择地区，这个决定了文档的语言，中文就是zh_CN
传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题”；#windowtitle：标题

step-3 校验

最新文章

热门文章