一、使用方法
1、命令行中使用Javadoc：javadoc -d 文档存放目录 源文件名.java
2、在IDEA中使用：Tools --> Generate JavaDoc
3、在Androidstudio中使用：Tools -->Generate JavaDoc
二、常用标签
| 标签 | 说明 |
|---|---|
| @version | 版本号 |
| @author | 作者（可以有多个） |
| @return | 对函数返回值的描述 |
| @deprecated | 标识过期API，表示该API可以用，但不推荐 |
| @throws | 可能出现的异常 |
| @exception | 同@throws |
| @see | 引用，查看相关的内容，如类，方法，变量等，必须顶头写 |
| {@link 包、类、成员} | 引用，同@see，但可写在任意位置 |
| {@value} | 对常量注释，如果其值包含在文档中，通过改标签引用常量的值 |
| {@code text} | {@code text}将文本标记为code，将文本标记为代码样式的文本 ,在Javadoc成只要涉及到类名或者方法名，都需要使用@code进行标记 |
| @param | 参数 |
| @inheritDoc | 用于继承父类中的Javadoc，父类的文档注释，被继承到了子类 |
三、
写在类上的文档标注一般分为三段：
第一段：概要描述，通常用一句话或者一段话简要描述该类的作用，以英文句号结束
第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束
第三段：文档标注，用于标注作者，创建时间，参阅类等信息生成文档是HTML格式。
换行用<br>
分段<p>(写在段前）
版权声明：本文为duanerduan原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接和本声明。