JavaScript 注释

在 JavaScript 中，注释是用来解释代码或暂时禁用代码的文本，它们不会被 JavaScript 引擎执行。JavaScript 支持两种类型的注释：

1. 单行注释

使用双斜杠 // 表示单行注释：

// 这是一个单行注释
let x = 5; // 这也是一个单行注释，可以跟在代码后面

2. 多行注释

使用 /* */ 表示多行注释：

/*
这是一个
多行注释
可以跨越多行
*/
let y = 10;

注释的用途

1. 代码解释：说明代码的功能或逻辑

   // 计算圆的面积
   function calculateArea(radius) {
     return Math.PI * radius * radius;
   }
   

2. 调试代码：暂时禁用某些代码

   // console.log("调试信息"); // 这行被注释掉，不会执行
   

3. 文档生成：使用特定格式的注释生成文档（如 JSDoc）

   /**
    * 计算两个数字的和
    * @param {number} a - 第一个数字
    * @param {number} b - 第二个数字
    * @returns {number} 两个数字的和
    */
   function sum(a, b) {
     return a + b;
   }
   

最佳实践

• 保持注释简洁明了
• 避免过度注释显而易见的代码
• 及时更新与代码变更相关的注释
• 使用注释解释"为什么"而不是"做什么"（代码本身应该能说明做什么）

注释是编写可维护代码的重要部分，但记住，好的代码应该尽可能自文档化，减少对注释的依赖。