JavaDoc
javadoc命令是用来正常自己API文档的,用于描述类或者方法的作用。可以写在类的上面和方法上面。
写在类上面的JavaDoc
写在类上的文档标注一般分为三段:
- 第一段:概要描述,通常用一句或者一段话简要描述该类的作用,以英文句号作为结束
- 第二段:详细描述,通常用一段或者多段话来详细描述该类的作用,一般每段话都以英文句号作为结束
- 第三段:文档标注,用于标注作者、创建时间、参阅类等信
参数信息
- @auther 作者名
- @version 版本号
- @since 指明需要最早使用的JDK版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
生成JavaDoc
通过IDEA生成Javadoc: Tools --> Generate JavaDoc -->
注意要配置编码,如果不配送为生成乱码,还需要配置Output directory
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-oIXomq1k-1614861681645)(C:\Users\六眼飞鱼\Desktop\学习\QQ图片20210304202758.png)]
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-gMMaBDCT-1614861681648)(C:\Users\六眼飞鱼\Desktop\学习\QQ图片20210304203757.png)]
-
Whole project : 整个项目都生成
-
Uncommitted files : 没有提交的文件
-
Custom scope: 自定义范围 :project files 项目文件,project production files 项目产品文件,project test files 项目的测试文件, 未知范围,class hierarchy 类层
-
include test source: 包含测试目录
-
include JDK and library sources in -sourcepath:包含jdk和其他的第三方jar
-
link to JDK documentation (user-link option) : 链接到JDK api
-
Output directy: 生成的文档存放的位置
-
private、package、protected、public :生成文档的级别(类和方法)
-
右边的Generate…是选择生成的文档包含的内容,依次对应顺序:层级树 导航 索引 单独的字母索引
-
再右边是生成的文档包含的内容信息,依次对应顺序:使用 作者 版本 废弃 废弃名单
-
Locale 语言类型,zh-CN 中文
-
Other command line arguments: 其他参数
-
Maximum heep size (Mb): 最大堆栈
本文设置 -encoding UTF-8 -charset UTF-8 -windowtitle “test” 设置了编码字符集都是utf-8,并设备文档标签标题
最后在所生成文档位置打开查看(index.html)文件。