开发SDK时，一般需要提供开发文档，自动生成文档时，需要注意如下事情：
- build.gradle配置，需要配置 编译所使用的sdk. 仅仅生成api文档时使用，编译apk时候，需要注释掉。
// 这行仅仅用于生成 api 文档时使用，编译代码时，需要注释掉
implementation fileTree(dir: 'E:\AndroidSDK\platforms\android-35', include: ['*.aar', '*.jar'], exclude: [])
2. 需要使用标准的注释，如果有错误的，则生成时会报错
/**
* java doc 测试
* @author zhangsan
* @since 2025/12/26
*/
public class JavaDocTest {
/**
* 该方法用于测试
* @param str 显示字符串
* @return int 返回测试结果
* */
public int JavaDocTest(String str){
return 0;
}
}
标准的注释如下：
javadoc 标签
javadoc 工具软件识别以下标签：
| 标签 | 描述 | 示例 |
|---|---|---|
| @author | 标识一个类的作者 | @author description |
| @deprecated | 指名一个过期的类或成员 | @deprecated description |
| {@docRoot} | 指明当前文档根目录的路径 | Directory Path |
| @exception | 标志一个类抛出的异常 | @exception exception-name explanation |
| {@inheritDoc} | 从直接父类继承的注释 | Inherits a comment from the immediate surperclass. |
| {@link} | 插入一个到另一个主题的链接 | {@link name text} |
| {@linkplain} | 插入一个到另一个主题的链接，但是该链接显示纯文本字体 | Inserts an in-line link to another topic. |
| @param | 说明一个方法的参数 | @param parameter-name explanation |
| @return | 说明返回值类型 | @return explanation |
| @see | 指定一个到另一个主题的链接 | @see anchor |
| @serial | 说明一个序列化属性 | @serial description |
| @serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 | @serialData description |
| @serialField | 说明一个ObjectStreamField组件 | @serialField name type description |
| @since | 标记当引入一个特定的变化时 | @since release |
| @throws | 和 @exception标签一样. | The @throws tag has the same meaning as the @exception tag. |
| {@value} | 显示常量的值，该常量必须是static属性。 | Displays the value of a constant, which must be a static field. |
| @version | 指定类的版本 | @version info |
- 生成api 文档 点击 androidSutio tools ->Generate JavaDoc
弹出的对话框->Output directory填写输出的文件夹->Other command line arguments 填写 -encoding utf-8 -charset utf-8
生成文档后，会自动用浏览器打开。
