ightning-l/rules icon
public
Published on 5/15/2025
嵌入式开发规范

Rules

Build & Development Commands

  • 使用 make 命令来编译和构建项目,确保使用正确的编译器和工具链。
  • 在开发过程中,使用 make clean 来清理临时文件和中间文件,以确保干净的构建环境。
  • 如果需要调试,使用 gdb 或者集成的调试工具(如 Eclipse)来进行调试。
  • 使用版本控制工具(如 Git)来管理代码,确保代码版本的清晰和团队协作的顺畅。

Testing Guidelines

  • 测试代码时,确保使用单元测试框架(如 CMocka 或 Ceedling)来对每个功能模块进行测试。
  • 测试覆盖率应尽可能达到 90% 以上,关键模块的测试覆盖率要接近 100%。
  • 在测试环境中进行压力测试和性能测试,验证系统在高负载条件下的稳定性和响应速度。
  • 对于嵌入式系统,进行硬件相关的测试,确保外设接口(如串口、I2C、SPI等)正常工作。

Code Style & Guidelines

  • 注释使用详细的中文
  • 代码应遵循规范的命名规则,变量名、函数名采用小写字母和下划线分隔的命名风格,类名使用大驼峰命名法。
  • 每个函数的功能要简洁明确,尽量做到一个函数完成一个具体的任务。
  • 代码应避免硬编码,使用宏定义或者配置文件来管理常量值,方便后续维护和修改。
  • 使用适当的注释来解释复杂的算法或功能模块,注释应简洁明了,避免多余的重复描述。
  • 避免使用全局变量,确保代码模块化,方便维护和扩展。

Documentation Guidelines

  • 项目的文档应包括详细的系统架构说明、硬件接口文档、通信协议文档以及代码说明。
  • 每个模块的功能、输入输出参数以及返回值应清楚地写在函数的文档注释中,尤其对于外部接口函数。
  • 系统的使用说明文档要简洁易懂,包含安装、配置、使用和故障排除的详细步骤。
  • 定期更新文档,确保文档与代码同步,特别是接口和协议的变动要及时记录。
  • 回复的时候尽可能使用中文回复