JavaDoc

通过注释/***/编写

package com.wang.base;

/**
 * @author 作者
 * @version 版本
 * @since jdk版本
 */
public class Doc {
    String name;

    /**
     *
     * @return 返回结果
     */
    public String getName() {
        return name;
    }

    /**
     *
     * @param name 入参
     * @throws Exception 异常
     */
    public void setName(String name) throws Exception{
        this.name = name;
    }
}

通过命令生成

通过cmd进入到需要生成javadoc文件的路径下,输入javadoc -encoding UTF-8 -charset UTF-8 DOC.java,回车即可
(一次性生成多个文件、包括分包的文档未找到如何通过命令生成,即类似jdk的javadoc文档的生成,但因为用的较少,待以后再找找看)

通过idea生成

点击Tools下的Generate JavaDoc,然后选择需要生成的范围以及生成到的路径,包括一些其他命令,也可以在生成的配置面板中进行设置,例如编码的设置

查看javadoc

点击生成的index.html即可

posted @ 2022-10-11 16:38  King泰妍  阅读(24)  评论(0)    收藏  举报