Javadoc 是从源代码中的 doc 注释生成 HTML 格式的 API 文档的工具

Andorid Studio中自带了一部分 Javadoc tags,但是有些时候可能满足不了需求,或者想用一些自定义的 tags。这时候就需要自己定义 tags 了。

下面先介绍一下自带 tags:

Tag Description
@author 文件作者
@param 参数
@return 返回值
@throw 抛出的异常
@see 参考其他 API
{@link} 同上
{@linkplain} 同上
@deprecated 不推荐使用
@since JDK版本
@version 当前版本
{@link} 参考其他类或方法
{@code} 注释中写入代码

{@link}@see 区别:

@see 只能放开每行开头,{@link} 可以方法任意位置
@see 会在 JavaDoc 里面生成一个 另请参阅: 的字段

示例代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/**
* javaDoc 测试1
* @author Kevin
* @data 2017/5/22
*/
public class JavaDocTest1 {

/**
* 测试方法2
* <br></br>
* 我是@link:{@link JavaDocTest2}
* <br></br>
* 我是@code:{@code name}
*
* @param name 名字
* @return 名字字符串
* @throws NullPointerException 空指针异常
* @see JavaDocTest2
*/
public String test2(String name) throws NullPointerException {
return null;
}
}

生成的 Javadoc:

类描述

方法资料

在 Andorid Studio 中 Tools -> Generate Javadoc 可以生成 Javadoc

需要在 Other command line arguments: 选项中配置 -encoding utf-8 -charset utf-8 -tag ,否则生成的中文文档的汉字为乱码

Andorid Studio配置

如果要自定义 tag,拿我文件中的 @data 来说,则需要在 Other command line arguments: 中配置 -tag data:a:"日期:" ,否则生成的文档中没有该 tag 的信息