前端js专业代码编写规范 (8)
前端js专业代码编写规范
1. 命名规范
命名必须具备“自解释”性，严禁使用拼音或无意义缩写。变量名采用小驼峰（如 userAge），类名采用大驼峰（如 OrderService），常量全大写下划线分隔（如 MAX_RETRY_COUNT）。布尔变量应以 is/has/can 开头（如 isValid）。命名应精准反映业务含义，避免使用 data、info、temp 等模糊词汇。
2. 函数设计
严格遵循单一职责原则（SRP），一个函数仅做一件事。函数长度建议控制在 20 行以内，缩进层级不超过 3 层。参数数量不宜超过 3 个，过多参数应封装为对象。避免使用标识参数（如 Boolean），应拆分为独立函数。函数名应为动词或动词短语（如 getUserById），清晰表达其执行动作。
3. 注释与文档
代码逻辑应优先通过清晰的结构和命名来表达，注释仅用于解释“为什么”而非“是什么”。必须为公共接口编写 Javadoc/Docstring，说明参数、返回值及可能的异常。及时清理废弃代码与注释，避免误导。
4. 错误处理
优先使用异常机制而非错误码处理异常流程。捕获异常时，禁止直接吞掉或仅打印堆栈，应进行适当的日志记录、清理资源或向上抛出。对外接口需提供明确的错误信息。
5. 格式与风格
严格遵守团队统一的语言风格指南（如 Java Google Style、Python PEP 8）。保持代码垂直与水平方向的整洁，逻辑相关的代码应靠近，适当使用空行分隔段落。每行代码长度建议控制在 80-120 字符以内，避免频繁横向滚动。
6. 测试与质量
核心业务逻辑必须覆盖单元测试，遵循 FIRST 原则。代码提交前必须通过静态分析工具（如 SonarQube）检查，消除潜在 Bug与代码异味。持续重构，保持代码库的健康度。
本文更新网址：https://feilong.org/js-professional-coding-standards
2026-06-05 ~ 2026-06-05
加入收藏夹，查看更方便。
分类： js教程