Java Doc学习

Java Doc学习

• javadoc命令是用来生成自己的API文档的
• 常用的参数信息

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

• Overview (Java Platform SE 8 ) (oracle.com)

• 生成注释文档

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

# -d 指定生成文档的文件夹
# -encoding utf-8 指定编码方式为uft-8
# -charset utf-8 指定使用的字符集为utf-8