核心原则

  1. 一致性：遵循项目约定的风格规范，如缩进、命名规则、注释格式等。
  2. 可读性：优先清晰表达逻辑，避免过度优化导致理解困难。
  3. 简洁性：删除冗余代码，保持函数和模块短小精悍。
code_quality

语言规范

  • 命名：变量名使用snake_case，函数名使用camelCase（如：user_id vs getUserData）
  • 格式：
    • 使用4空格缩进，禁止使用TAB
    • 每行不超过80字符，长代码用\换行
  • 注释：关键逻辑需添加注释，注释语言与代码一致（如：中文注释需用#或//）

协作建议

  • 提交前运行eslint或prettier检查格式
  • 通过社区项目贡献指南了解具体流程
  • 遇到风格争议时，优先参考项目历史提交记录
clean_code

📌 扩展阅读：代码风格对团队协作的影响