JavaScript 代码风格指南

良好的代码风格可以提高代码的可读性、可维护性和团队协作效率。以下是 JavaScript 代码风格的主要建议：

1. 基本格式

• 缩进: 使用 2 个空格（行业主流选择）

  function example() {
    console.log('Hello');
  }
  

• 行长度: 建议不超过 80-100 个字符

• 分号: 始终使用分号（避免自动分号插入的陷阱）

  const name = 'John';
  

2. 命名规范

• 变量和函数: 小驼峰式 (camelCase)

  let userName = 'Alice';
  function calculateTotal() {}
  

• 常量: 全大写，下划线分隔 (SCREAMING_SNAKE_CASE)

  const MAX_COUNT = 100;
  

• 类: 大驼峰式 (PascalCase)

  class UserAccount {}
  

• 私有成员: 以下划线开头（仅约定，非真正私有）

  this._privateMethod = function() {};
  

3. 变量声明

• 使用 const 和 let，避免 var
• 每个声明单独一行
• 声明时初始化

  const name = 'John';
  let age = 30;
  

4. 空格和换行

• 操作符周围添加空格

  const sum = 1 + 2;
  

• 逗号后加空格

  const colors = ['red', 'green', 'blue'];
  

• 函数参数和调用时参数列表后不加空格

  function greet(name, age) {}
  greet('John', 30);
  

• 代码块之间留空行

  function foo() {
    const x = 1;
    
    if (x === 1) {
      // ...
    }
  }
  

5. 引号

• 使用单引号 '（除非字符串中包含单引号）

  const message = 'Hello world';
  

6. 对象和数组

• 简写属性

  const name = 'John';
  const user = { name }; // 而不是 { name: name }
  

• 方法简写

  const obj = {
    foo() {  // 而不是 foo: function() {}
      // ...
    }
  };
  

• 对象和数组字面量尾随逗号

  const arr = [
    'one',
    'two',
    'three', // 尾随逗号使增删元素更清晰
  ];
  

7. 函数

• 使用函数表达式而非函数声明（特殊情况除外）

  const foo = function() {};
  

• 箭头函数优先

  const sum = (a, b) => a + b;
  

8. 条件语句

• 使用严格相等 === 和 !==

• 简写条件

  if (name) { ... } // 而不是 if (name !== '') 
  

• 三元运算符用于简单条件

  const status = age >= 18 ? 'adult' : 'minor';
  

9. 模块

• 使用 ES6 模块语法

  import { module } from 'module';
  export default function() {};
  

10. 注释

• 单行注释: //
• 多行注释: /* ... */
• 文档注释: JSDoc 风格

  /**
   * 计算两个数的和
   * @param {number} a - 第一个数
   * @param {number} b - 第二个数
   * @returns {number} 两数之和
   */
  function add(a, b) {
    return a + b;
  }
  

工具推荐

• ESLint: 代码检查工具
• Prettier: 代码格式化工具
• EditorConfig: 统一编辑器配置

常见风格指南

• Airbnb JavaScript 风格指南
• Google JavaScript 风格指南
• StandardJS

选择一种风格指南并保持团队一致是最重要的。