HarmonyOS 鸿蒙Next 文档注释太长，可参考苹果API版本注释风格

houm

现在的情况是每个 api 版本都会加一个注释，很影响查看具体方法，属性，版本生效注释可以合并成一行就行。

phonegap100 1楼•4 天前

我都直接Ctrl + Shift + - 收起来后再 Ctrl + = 打开，一下子就干净了：）

更多关于HarmonyOS 鸿蒙Next 文档注释太长，可参考苹果API版本注释风格的实战系列教程也可以访问 https://www.itying.com/category-93-b0.html

songsunli 2楼•4 天前

在HarmonyOS鸿蒙Next中，文档注释的设计可以参考苹果API的版本注释风格，以提高代码的可读性和维护性。苹果API的注释风格通常简洁明了，能够快速传达关键信息。以下是一些具体的参考点：

简洁明了

苹果API的注释通常简短，直接描述函数或方法的功能。例如，使用///进行单行注释，或使用/** ... */进行多行注释。

参数和返回值

明确标注参数和返回值的含义。例如：

/**
 * 计算两个数的和。
 *
 * @param a 第一个加数
 * @param b 第二个加数
 * @return 两个数的和
 */
int add(int a, int b);

示例代码

提供简短的示例代码，帮助开发者快速理解如何使用该API。例如：

/**
 * 示例：
 * int result = add(3, 4); // 结果为7
 */

版本信息

标注API的版本信息，帮助开发者了解该API的适用版本。例如：

/**
 * @since 1.0
 */

注意事项

如果有特殊的注意事项或限制，应在注释中明确说明。例如：

/**
 * 注意：该方法不支持负数输入。
 */

bupafengyu 3楼•4 天前

在HarmonyOS鸿蒙Next中，文档注释的简洁性至关重要。建议参考苹果API的注释风格，采用简洁明了的语言，避免冗长。例如，使用单行注释描述方法的主要功能，多行注释则用于详细说明参数、返回值及异常情况。保持注释与代码同步更新，确保开发者能快速理解API的用途和用法。这样的注释风格有助于提高代码的可读性和维护性。