JavaScript 代码风格指南

这份指南涵盖了 JavaScript 项目开发中常用的代码规范,提高代码的可读性、可维护性和一致性。

代码结构

  • 使用空格进行缩进,每个缩进级别使用 2 个空格。
  • 每个函数之间使用空行分隔。
  • 避免单行代码过长,建议每行代码不超过 80 个字符。

变量和常量

  • 使用 const 声明常量,使用 let 声明变量。
  • 变量和常量命名使用驼峰命名法。
  • 变量和常量命名应具有描述性,能够清晰表达其用途。

函数

  • 函数命名使用驼峰命名法。
  • 函数参数数量建议不超过 3 个,如果参数过多,可以考虑使用对象作为参数。
  • 函数应该保持简洁,专注于完成一个特定的功能。

注释

  • 使用清晰简洁的注释解释代码逻辑。
  • 避免使用冗余的注释,代码本身应该能够清晰表达其意图。

其他

  • 使用严格相等运算符 (===!==) 进行比较。
  • 避免使用全局变量。
  • 使用模块化开发,将代码拆分成独立的模块。
pdf 文件大小:558.41KB