本项目遵循以下代码规范,以确保代码质量和协作效率。

语言风格

  • 中文:本规范主要使用中文描述,以方便中文用户理解。
  • 英文:对于需要国际化或方便英文用户阅读的部分,我们将提供英文翻译。

规范内容

  1. 编码规范

    • 使用一致的缩进和空格。
    • 函数和类名应使用驼峰命名法。
    • 变量名应清晰、简洁,避免使用缩写。
  2. 注释规范

    • 每个函数和复杂逻辑块前应添加注释,说明其功能和目的。
    • 注释应简洁明了,避免冗余。
  3. 代码审查

    • 所有代码提交前必须经过代码审查。
    • 代码审查应关注代码质量、规范性和安全性。
  4. 版本控制

    • 使用Git进行版本控制。
    • 每次提交应包含清晰的提交信息。
  5. 扩展阅读

图片示例

示例图片

返回项目首页