JavaScript 命名规范:变量和函数命名指南
💡
原文英文,约1200词,阅读约需5分钟。
📝
内容提要
JavaScript命名规范对于编写清晰、可读和可维护的代码非常重要。使用描述性名称、camelCase用于变量和函数、PascalCase用于类名、UPPER_SNAKE_CASE用于常量。避免保留关键字和魔术数字,保持一致性。函数命名用动词-名词对,单字母变量仅用于循环计数器。异步函数应标明异步特性,私有属性和方法可用下划线或#前缀。命名空间用于组织大型项目代码。
🎯
关键要点
- JavaScript命名规范对于编写清晰、可读和可维护的代码至关重要。
- 使用描述性和有意义的名称,避免使用模糊的短名称。
- 变量和函数使用camelCase命名规范。
- 类名使用PascalCase命名规范。
- 常量使用UPPER_SNAKE_CASE命名规范。
- 布尔变量应使用is、has或should等前缀。
- 避免使用保留关键字作为变量或函数名称。
- 函数名称应使用动词-名词对来表示其功能。
- 除循环计数器外,避免使用单字母变量名。
- 避免使用魔术数字和字符串,使用描述性常量代替。
- 在整个代码库中保持一致性。
- 文件和目录命名应使用kebab-case。
- 异步函数应在名称中明确标识其异步特性。
- 私有属性和方法应使用下划线或#作为前缀。
- 对于大型项目,使用命名空间来组织相关函数或变量。
🏷️
标签
➡️