JavaDoc生成文档

控制台下生成文档操作

# 简单的使用，-d 后面为生成文档存放目录，-encoding -charset是为了保证中文注释生成文档时不产生乱码
javadoc xxx.java -d XXX -encoding UTF-8 -charset UTF-8

值得注意的是在IDEA中控制台默认路径是项目根目录，需按路径写（示例：src/com/zuncle/test/xxx.java）

# 示例
javadoc src/com/zuncle/test/xxx.java -d XXX -encoding UTF-8 -charset UTF-8

IDEA下生成文档

Tools -> Generate JavaDoc

• Generate JavaDoc scope: 选择生成文档范围，通常以模块或者单个文件
• output directory: 生成到指定文件夹
• Locale 需要生成的 JavaDoc: 以何种语言版本展示
• other command line arguments: 附加参数

---

常用参数	具体作用
@author	作者
@version	版本号
@since	jdk最低版本
@return	返回值
@param	参数
@throws	异常