JS 注释类型
单行注释
以//
开头,仅注释当前行内容:// 这是一条单行注释 const x = 10; // 注释也可以跟在代码后
多行注释
以/*
开头,以*/
结尾,可跨行:/* 这是多行注释,可以跨越多行 */ const y = 20;
注释的用途
代码说明
解释复杂逻辑或代码意图,便于后期维护:// 计算圆的面积(公式:πr²) const area = Math.PI * radius ** 2;
调试辅助
临时禁用代码块而不删除:// console.log("调试信息"); function test() { /* 待实现 */ }
文档生成
JSDoc 风格注释用于生成 API 文档:/*** 计算两数之和* @param {number} a 第一个加数* @param {number} b 第二个加数* @returns {number} 和*/ function add(a, b) { return a + b; }
注意事项
- 避免过度注释:直观的代码无需冗余注释,如
x = 5; // 赋值
。 - 及时更新:修改代码时需同步更新注释,避免误导。
- 多行注释嵌套:JS 不支持
/* /* 嵌套 */ */
,会导致语法错误。