第一:
打开idea,选择项目。点击工具栏 Tools->Generate JavaDOC
第二:
主要分为三部分内容。
1,Generate JavaDoc scope 要扫描生成api的范围。
(1)整个项目
(2)单个模块
(3)单个java类
(4)自定义范围
2,属性。主要包括文件输入路径(指向一个文件夹),class及方法的生产范围(根据修饰符确定),要生成的注释范围,api文档生成后的字符
3,命令参数 Other command heap size:可添加多个参数。该命令参数主要以javadoc 命令为主。(后面详细介绍)
以上选择后点击 ok 即可生成
第三:
javadoc就是jdk内自带的命令,具体参数大家可以在cmd命令窗口内输入 javadoc -help查看
常用命令:
-encoding UTF-8 源代码字符集格式
-charset UTF-8 生产的javadoc 超文本字符集格式
-windowtitle “api文档” api打开后名称
第四:生成效果如下
index.html为文档入口
打开后如下:
人生在世,杂事七八;饭要少吃,事要多知;抽个时间,总结一下;乐在分享,自在提升