JavaDoc

JavaDoc

JavaDos命令

• javaDoc命令
• 参数信息
• javadoc命令运行

javaDoc命令

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

参数信息

1. @author 作者名
2. @version 版本号
3. @since 指明最早需要的jdk版本
4. @param 参数名
5. @return 返回值情况
6. @throws 异常抛出情况

javadoc命令运行

想生成自己的API文档只需要在自己的类文件夹打开cmd命令行提示符
输入以下命令，其中DOC是文件名，UTF-8是为了防止类信息中有中文

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