本文旨在提供一份关于 JavaScript 编程风格的指南,帮助开发者编写清晰、可维护的代码。
语言风格
默认语言为中文,如需英文版本,请访问 /en/javascript_style_guide
。
基本原则
- 一致性:保持代码风格一致,便于阅读和维护。
- 简洁性:代码应尽可能简洁,避免冗余。
- 可读性:代码应易于阅读和理解。
代码格式
- 缩进:使用 2 个空格进行缩进。
- 换行:每行代码不超过 80 个字符。
- 空格:在操作符前后添加空格,例如
let a = 1 + 2;
。
变量命名
- 驼峰命名法:变量名使用驼峰命名法,例如
let userName = '张三';
。 - 常量命名:常量使用全大写字母,单词间用下划线分隔,例如
const MAX_SIZE = 100;
。
代码注释
- 单行注释:使用
//
进行单行注释。 - 多行注释:使用
/* ... */
进行多行注释。
示例代码
// 定义一个函数
function add(a, b) {
return a + b;
}
// 调用函数
let result = add(1, 2);
console.log(result); // 输出:3
扩展阅读
更多关于 JavaScript 编程风格的信息,请访问 JavaScript 编程风格指南。