Java学习-基础10JavaDoc文档注释

JavaDoc文档注释

JavaDoc

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

参数信息：

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

package com.base.www;

/**
 * @author burgess
 * @version 1.0
 * @since 1.8
 */

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

}

javadoc命令

• -encoding，-charset指定编码，避免中文乱码情况
• -d 指定文档生成路径

javadoc -encoding UTF-8 -charset UTF-8 -d ./Doc java文件