JS 注释规范

1. 单行注释： 使用两个斜杠 // 开始，直到行尾都是注释内容。

   // 这是一个单行注释
   var message = 'Hello, World!' // 这也是一个单行注释

2. 多行注释： 使用 /* 开始，*/ 结束，可以跨越多行。

   /*
   这是一个多行注释
   它可以跨越多行。
   */
   var message = 'Hello, World!'

3. 文档注释： 也称为 JSDoc，用于生成 API 文档，通常用于描述函数、类、方法、参数和返回值。

   /**
    * 这是一个函数，用于计算两个数的和
    * @param {number} a 第一个加数
    * @param {number} b 第二个加数
    * @return {number} 两个数的和
    */
   function add(a, b) {
     return a + b
   }

4. 注释规范：

   • 简洁明了：注释应该简洁明了，直接解释代码的功能和目的。
   • 更新维护：当代码更改时，相应的注释也应该更新，以保持一致性。
   • 避免过度注释：如果代码本身就很清晰，就不需要过多的注释。
   • 避免误导：确保注释内容与代码逻辑一致，避免产生误导。
   • 注释位置：单行注释通常放在被注释代码的上方或同一行，多行注释则根据实际情况放置。

5. 注释工具：

   • 使用代码编辑器或 IDE 的注释快捷键可以提高注释的效率。
   • 利用代码编辑器的注释功能，如自动生成函数注释模板。