本文档旨在为开发者提供统一的编码标准，以提高代码质量和团队协作效率。如需了解如何参与项目，请查看贡献指南。

命名规范 📌

  • 变量名：使用小写字母和下划线，如 user_name
  • 函数名：动词开头，小驼峰命名，如 calculateTotal()
  • 类名：大驼峰命名，如 ProjectAController
  • 常量名：全大写加下划线，如 MAX_USERS

代码结构 🧱

  1. 文件结构
    • 每个模块遵循 功能/子功能.js 命名
    • 顶层目录包含 utils、models、services 等子目录
  2. 缩进与空格
    • 使用 4 个空格进行缩进
    • 二元运算符两侧保留空格，如 let a = 5 + 3;
  3. 注释规范
    • 函数注释需包含参数说明与返回值示例
    • 关键逻辑添加 <!-- 注意：此处为特殊处理 --> 标记

开发工具 🛠️

  • 推荐使用 VS Code 作为主要编辑器
  • 代码格式化工具：Prettier（配置文件位于 .prettierrc）
  • 单元测试框架：Jest

扩展阅读 📚

代码规范
团队协作