适用对象

该规范适用于U9客户化开发人员。

注释规范细则

代码注释是一种重要的软件开发实践，它可以提高代码的可读性、可维护性和可理解性。

在有处理逻辑的代码中，开发人员有效注释量必须在20％以上。

文件注释

• 在每个源文件的开头，使用summary标签描述文件的功能、用途和重要变更历史。
• 可以包括作者、创建日期、修改记录等信息。

示例：

类/接口注释：

• 在每个类或接口的前面，使用summary标签描述其目的、职责和关键方法。
• 可以引用相关文档、规范或设计模式。

示例：

函数/方法注释：

• 在每个方法或函数的前面，使用summary标签描述其功能、输入参数、返回值和可能的异常情况。
• 可以使用标签为每个参数添加描述。
• 可以使用标签描述返回值。
• 可以使用标签描述可能的异常情况。

示例：

字段/属性注释：

• 在每个字段或属性的前面，使用summary标签描述其用途和限制条件。

示例：

事件/委托注释：

• 在每个事件或委托的前面，使用summary标签描述其用途和触发条件。

示例：

注释风格和格式：

• 使用清晰、简洁的语言编写注释，避免使用难懂的缩写或术语。
• 使用正确的语法和标点符号，确保注释的可读性。
• 保持一致的注释风格，例如使用句子开头大写字母、使用行内注释或块注释等。