1. 缩进和空格:
- 使用 2 或 4 个空格进行缩进,不要使用制表符。
- 在代码块之间保持一致的缩进。
// 推荐
function example() {
if (condition) {
// code
} else {
// code
}
}
// 不推荐
function example() {
∙∙if (condition) {
∙∙∙∙// code
∙∙} else {
∙∙∙∙// code
∙∙}
}
2. 分号:
- 使用分号结束语句,以防止出现意外的错误。
- 在可能导致 ASI(Automatic Semicolon Insertion)问题的情况下,特别是在 return、break、continue、throw 语句之前,最好显式地加上分号。
// 推荐
var value = 42;
console.log(value);
// 不推荐
var value = 42
console.log(value)
3. 命名规范:
- 使用驼峰式命名法(camelCase)。
- 变量和函数名使用有意义的名字,避免使用缩写。
- 类名使用首字母大写的驼峰式命名法。
// 推荐
var myVariable = 42;
function calculateTotal() {
// code
}
class MyClass {
// code
}
// 不推荐
var my_variable = 42;
function calcTotal() {
// code
}
class my_class {
// code
}
4. 引号:
- 在字符串中使用单引号或双引号,保持一致性。
- 推荐使用单引号。
// 推荐
var name = 'John';
// 不推荐
var name = "John";
5. 注释:
- 使用注释解释代码的目的、重要信息或者特殊的注意事项。
- 避免注释掉大段代码,应该使用版本控制系统来管理代码历史。
// 单行注释
/*
多行注释
*/
/**
* 文档注释
*/
6. 对象和数组:
- 对象和数组的左括号 { 或 [ 前后添加空格,内部元素前后不添加空格。
- 对象的属性名使用引号,保证代码的一致性。
// 推荐
var person = {
name: 'John',
age: 30
};
var colors = ['red', 'green', 'blue'];
// 不推荐
var person = {name: 'John', age: 30};
var colors = ['red', ' green', 'blue'];
7. 箭头函数:
- 对于单行箭头函数,可以省略大括号和 return,否则使用完整的语法。
- 如果函数体有多行,使用大括号包裹。
// 推荐
const add = (a, b) => a + b;
// 推荐
const multiply = (a, b) => {
return a * b;
};
// 不推荐
const subtract = (a, b) => { return a - b; }
8. 其他建议:
- 避免使用全局变量,使用 let 或 const 声明变量。
- 避免使用 var,优先使用 let 和 const。
- 尽量减少全局作用域的变量。
- 避免在循环中使用函数表达式。
这些规范只是一些建议,实际项目中可能会有不同的规范,关键是在团队中保持一致性,以提高代码质量和可维护性。可以使用工具如 ESLint 来自动检测和修复代码规范。
转载请注明出处:http://www.pingtaimeng.com/article/detail/12811/JavaScript