什么是注释
注释就是对代码进行解释，使代码更易读，也方便其他开发者理解代码的功能。
单行注释
// 这是一个单行注释
console.log('hello world');
多行注释
/*
这是一个多行注释
在控制台输出 hello world
*/
console.log('hello world');
文档注释
文档注释是一种特殊的注释，用于生成 API 文档，它通常包含函数、类、方法等的说明和示例。
/**
* 计算两个数字的和。
* * @param {number} a - 第一个加数
* @param {number} b - 第二个加数
* @returns {number} 返回两个数的总和
* * @example
* const result = add(1, 2); // 3
*/
function add(a, b) {
return a + b;
}## 什么是注释
注释就是对代码进行解释，使代码更易读，也方便其他开发者理解代码的功能。
## 单行注释
```javascript
// 这是一个单行注释
console.log('hello world');
多行注释
/*
这是一个多行注释
在控制台输出 hello world
*/
console.log('hello world');
文档注释
文档注释是一种特殊的注释，用于生成 API 文档，它通常包含函数、类、方法等的说明和示例。
/**
* 计算两个数字的和。
* * @param {number} a - 第一个加数
* @param {number} b - 第二个加数
* @returns {number} 返回两个数的总和
* * @example
* const result = add(1, 2); // 3
*/
function add(a, b) {
return a + b;
}
代码规范
注释需简洁易懂，避免复杂词汇与专业术语，同时要与代码内容保持同步，随代码更新及时调整。一套优质的 JavaScript 代码规范，不仅能有效减少 Bug 产生，还能显著降低团队协作中的沟通成本。
目前行业内最主流的规范是 Airbnb JavaScript Style Guide（Airbnb JavaScript 风格指南）。该指南制定了一套统一的代码风格标准，涵盖注释、缩进、空格、换行等核心编码细节。遵循这一规范，能让 JavaScript 代码的可读性和可维护性大幅提升。
## 代码规范
注释需简洁易懂，避免复杂词汇与专业术语，同时要与代码内容保持同步，随代码更新及时调整。一套优质的 JavaScript 代码规范，不仅能有效减少 Bug 产生，还能显著降低团队协作中的沟通成本。
目前行业内最主流的规范是 Airbnb JavaScript Style Guide（Airbnb JavaScript 风格指南）。该指南制定了一套统一的代码风格标准，涵盖注释、缩进、空格、换行等核心编码细节。遵循这一规范，能让 JavaScript 代码的可读性和可维护性大幅提升。
