本文档旨在为社区成员提供一套代码编写规范,以提升代码质量和团队协作效率。

代码风格

  1. 命名规范

    • 变量、函数和类名应使用驼峰式命名法(camelCase)。
    • 常量名使用全大写字母,单词间用下划线分隔。
  2. 缩进与空格

    • 使用4个空格进行缩进。
    • 代码块前应添加一个空行。
  3. 注释

    • 函数和复杂逻辑块前应添加注释,说明其功能。
    • 注释应简洁明了,避免冗余。

代码审查

  1. 审查流程

    • 代码提交前,必须经过至少一位资深成员的审查。
    • 审查内容包括代码风格、逻辑正确性、性能优化等。
  2. 审查工具

    • 使用GitLab或GitHub等代码托管平台提供的代码审查功能。

资源链接

代码审查示例