JavaDoc生成文档

JavaDoc生成文档

javadoc命令是用来生成自己API文档的

参数信息

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

文档注释、类注释

package com.wang.base;
/**
 * @author wangzhen
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

    /**
     * @author wangzhen
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

javadoc DOS命令生成Doc文本

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

-encoding 编码格式为UTF-8，让页面显示中文准确
-charset让字符节编码也为UTF-8
防止乱码

JavaDoc生产文档

IDEA如何生成javadoc

选择Tools下面的Generate JavaDoc

依次选择设置即可导出