- javadoc命令是用来生成自己API文档的
- 格式
- javadoc [参数] java文件名
index.html即为文档主页
写在类上面的Javadoc:
写在类上的文档标注一般分为三段：
第一段：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束
第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束
第三段：文档标注，用于标注作者、创建时间、参阅类等信息
写在方法上的Javadoc:
写在方法上的文档标注一般分为三段：
第一段：概要描述，通常用一句或者一段话简要描述该方法的作用，以英文句号作为结束
第二段：详细描述，通常用一段或者多段话来详细描述该方法的作用，一般每段话都以英文句号作为结束
第三段：文档标注，用于标注参数、返回值、异常、参阅等
- 参数信息
- @auther 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
- 打开包目录
- 把命令行在包目录打开(在导航栏输入cmd+空格进入)
- 输入javadoc [参数] java文件名
例:javadoc -encoding UTF-8 -charset UTF-8 Doc.java
//注:这里的参数是为了避免中文乱码
在IDEA中点击 Tools > Generate javadoc:
进入：
解释说明:
Whole project:整个项目都生成文档
Custom scope: 自定义范围。
include JDK and … : 包含jdk和其他的第三方jar
link to JDK documentation…: 链接到JDK api
output directy :生成的文档存放的位置
private、package、protected、public :生成文档的级别（类和方法）
Generate…:是选择生成的文档包含的内容，层级树、导航、索引…
Generate右边的@:是生成的文档包含的内容信息，作者版本等信息
Locale :语言类型,zh-CN 或者不填
Other command line arguments: 其他参数
Maximum heep… :最大堆栈
建议使用UTF-8编码、否则会出现中文乱码: -encoding UTF-8 -charset UTF-8
点击ok进行开始打包javadoc：
可以看到打包成功:
打开index.html之后就是文档界面了:
