ArkTS 代码中如何添加作者信息

本文整理在 HarmonyOS / ArkTS 应用代码中添加作者信息的常用方式，包括 @author 注释标签、DevEco Studio 文件模板自动生成，以及注解与注释的区别。

一、使用 @author 注释标签

@author 是文档注释中的标准标签，用于标识作者信息，语法为：

@author 作者名/ID

1. 在文件头部添加

/**
 * @file UDP 服务封装
 * @author 你的名字/ID
 * @since 2026-10-27
 */

2. 在函数或类上添加

/**
 * 发送 UDP 字节数组
 * @param host 目标主机
 * @param port 目标端口
 * @param message 字节数组
 * @author Alice
 */
async sendMessage(host: string, port: number, message: number[]): Promise<void> {
  // ...
}

这种方式最通用，也便于后续生成 API 文档。

二、配置 DevEco Studio 自动生成作者信息

如果希望每次新建 .ets 文件时自动带上作者信息，可以配置文件模板。

配置路径：

File -> Settings -> Editor -> File and Code Templates -> Files -> ArkTS File

在模板内容中添加：

/**
 * 添加描述
 * @author Your ID
 * @since ${YEAR}-${MONTH}-${DAY}
 * Copyright © Huawei Technologies Co., Ltd.${YEAR}-${YEAR}. All rights reserved.
 */

其中：

• ${YEAR}：当前年份

• ${MONTH}：当前月份

• ${DAY}：当前日期

新建 ArkTS 文件时，这些变量会自动替换为当前日期。

三、注解（Annotation）与注释的区别

ArkTS 中的"注解（Annotation）"主要用于为类、方法等添加运行时或编译时可读取的元信息，常用于 AOP 插桩、日志埋点等场景。

而添加作者信息通常使用 @author 注释即可，一般不需要自定义注解，除非有在运行时动态读取作者信息的特殊需求。

四、总结

方式	关键操作	适用场景
@author 注释	在文件头或函数/类注释块中添加 @author 作者名	最通用、标准，利于生成文档
DevEco Studio 模板	配置 File and Code Templates 中的 ArkTS File 模板	新建文件时自动添加，规范统一
注解 Annotation	自定义注解接口	需要程序在编译或运行时读取作者信息的特殊场景