javadoc是将参数信息生成自己API文档的技术
参数信息
/**
*@author 作者名
*@version 版本号
*@since 指明需要最早使用的jdk版本
*@param 参数名
*@return 返回值情况
*@throws 异常抛出情况
*/
百度搜索jdk帮助文档,可以查看官方的帮助文档
生成帮助文档的操作流程
方法一:CMD方式
-
在代码中进行文档注释
-
打开CMD控制台,并进入到需要生成帮助文档的类的文件位置
可以先打开文件夹位置,然后在文件位置前输入cmd 并回车直接进入
-
控制台中输入以下内容并回车
javadoc -encoding UTF-8 -charset UTF-8 类名.java
(由于大部分帮助文档可能包含中文,为了防止乱码所以上面的代码中设置了编码格式为UTF-8)
- 生成一系列文件,其中index.html即为生成的帮助文档
方法二:IDEA工具生成方式
-
选择IDEA中选项栏中的Tool选项,并选择打开Generate JavaDoc
-
在弹出框中选择即将生成的文件的存放位置
-
填写下方Locale栏,输入
zh_CN
代表中文 -
Other command line arguments栏填写
-encoding UTF-8 -charset UTF-8
设置编码为UTF-8 -
打开第二步中所选的文件位置,即可查看生成的帮助文档,剩余部分与方法一相同
以上内容学习自B站UP主遇见狂神说,附:视频地址