如何撰写代码注释

编写清晰、简洁的代码注释对于代码的可读性和可维护性至关重要。有效的注释可以帮助其他开发者理解您的代码逻辑，方便代码维护和修改。

以下是一些编写代码注释的建议：

• 注释目的明确: 注释应该解释代码的功能，而不是重复代码本身。
• 简洁明了: 注释应简短扼要，避免使用过于复杂或专业术语。
• 准确无误: 确保注释与代码逻辑一致，避免出现错误信息。
• 更新同步: 当代码修改时，请及时更新对应的注释，保持一致性。
• 使用格式化: 可以使用代码格式化工具，使注释风格一致，提高可读性。

例如，以下是一段带有注释的代码片段：

// 计算两个数的和
function sum(a, b) {
  // 返回 a 和 b 的加和
  return a + b;
}

通过添加清晰的注释，可以使代码更加易于理解和维护。