JavaDoc
JavaDoc命令是用来生成自己API文档的
参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
如何生成JavaDoc文档
1. 使用命令行生成JavaDoc文档
javadoc -encoding UTF-8 -charset UTF-8 文件名.java
2. 使用IDEA生成JavaDoc文档
-
点击菜单栏 ----->Tools ----->Generate JavaDoc…
-
弹出的界面中,Output directory 选择自己的保存目录
Locale 框中输入 zh_CN ,这个就代表中文
Other command line arguments 框中输入这行代码
**-encoding utf-8 -charset utf-8 **
- 最后点击 OK,打开保存该JavaDoc的目录,找到 index.html文件,这就是所生成的API文档。