JavaScript 注释用于在代码中添加说明或备注，帮助代码的阅读和维护。注释不会被执行，它们仅用于解释代码的功能、逻辑或其他有用的信息。JavaScript 支持两种类型的注释：单行注释和多行注释。
1. 单行注释
单行注释用于在一行中添加注释，注释从 // 开始，直到行尾。
示例：
// 这是一个单行注释
let x = 10; // 变量 x 被初始化为 10
2. 多行注释
多行注释用于在多行中添加注释，注释从 /* 开始，到 */ 结束。它可以用于较长的说明或注释掉一部分代码。
示例：
/*
这是一个多行注释
可以用于添加较长的说明
或注释掉多行代码
*/
let y = 20;
3. 混合使用
在实际开发中，可以根据需要混合使用单行和多行注释。
示例：
// 这是一个单行注释
/*
这是一个多行注释
用于详细说明代码的逻辑
或暂时禁用一部分代码
*/
let z = 30; // 变量 z 被初始化为 30
4. 注释的最佳实践
- 清晰简洁：注释应该简洁明了，准确描述代码的功能或目的。
- 更新注释：随着代码的变化，确保更新相关的注释，以避免注释和代码之间的不一致。
- 避免多余的注释：避免在代码非常简单或自解释的地方添加多余的注释。注释应该补充代码，而不是重复代码本身。
- 使用文档注释：对于函数或类，使用文档注释来提供详细的描述、参数说明和返回值说明。虽然 JavaScript 本身没有官方的文档注释标准，但许多开发者使用 JSDoc 风格。
JSDoc 风格示例：
/**
* 计算两个数的和
* @param {number} a - 第一个数
* @param {number} b - 第二个数
* @returns {number} 两个数的和
*/
function add(a, b) {
return a + b;
}
5. 临时禁用代码
多行注释可以用于临时禁用一部分代码进行调试或测试。
示例：
/*
let debugValue = 42;
console.log(debugValue);
*/
总结
注释是编写易于维护和理解的代码的关键部分。它们帮助开发者理解代码的意图，并使得多人协作开发更加顺畅。