Android Studio：生成 JavaDoc

最新推荐文章于 2023-10-08 09:04:24 发布

原创最新推荐文章于 2023-10-08 09:04:24 发布 · 1k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#android #javadoc

Android 专栏收录该内容

133 篇文章

订阅专栏

本文介绍了如何在Android Studio中生成JavaDoc，包括通过Tools菜单的Generate JavaDoc选项配置导出范围，以及如何编写注释，如换行、列表和链接。此外，还提到了自定义注释模板的可能性。

Generate JavaDoc

Tools -> Generate JavaDoc

进入JavaDoc生成界面

Generate JavaDoc 配置

Generate JavaDoc

Android Studio 默认的编码格式为 utf-8，导出参数中必须带上：

-encoding utf-8 -charset utf-8

常用的是【Custom scope】，点击右侧的【…】，配置导出范围，例如：只导出部分类。

custom scope

注释示例

/**
 * 类说明
 * @author 公司名
 * @version 1.0.1
 */
public class Test {
    /**
     * 删除文件（耗时操作，不允许取消，慎用）
     * @param fileNames 文件名列表， <br />
     *                  若为null，则将进行格式化操作； <br />
     *                  若不为null，则删除指定文件；
     * @return 操作结果返回 {@link EnumCommResult#OK} 时，表示删除操作成功 <br />
     * <dl>
     * <dt> 其他错误原因如下： </dt>
     * <dd> 设备未连接    {@link EnumCommResult#DEVICE_NO_CONNECT} </dd>
     * <dd> 设备正在重连    {@link EnumCommResult#DEVICE_RECONNECTING} </dd>
     * <dd> 设备不支持（不支持 {@link EnumDeviceType#A}， {@link EnumDeviceType#B}）
     *                  {@link EnumCommResult#DEVICE_NOT_SUPPORT} </dd>
     * <dd> 参数错误    {@link EnumCommResult#PARAM_WRONG} </dd>
     * <dd> 设备无应答    {@link EnumCommResult#DEVICE_NOT_ANSWER} </dd>
     * <dd> 其他原因（操作过程抛出意料之外的异常）    {@link EnumCommResult#OTHER_ERROR} </dd>
     * </dl>
     */
    public EnumCommResult DeleteFile(String[] fileNames) {
    }
}

<br /> 换行

<dl><dt>标题</dt><dd>内容</dd></dl> 列表展示

{@link 类名#方法名或属性名} 链接到指定方法或属性