嵌入式代码规范

该文章是自己总结出来的编码风格,用于规范自己的代码,增强可读性,非标准规范。强制自己形成良好的编码风格,有利于开发大规模程序而不显得杂乱。参考STM32固件库编码风格和FreeRTOS编码风格。

  1. 修改第三方或者开源社区的代码,遵循原有的代码风格和社区的相关约定
  2. C/C++全新代码遵循WebKit风格
  • 每次commit之前,运行一遍clang-format(sudo apt install clang-format),下面的命令会直接修改源文件:
clang-format --style=WebKit -i filetocheck
  • 或者通过VSCode:
    嵌入式代码规范_第1张图片
    嵌入式代码规范_第2张图片
  1. 纯C代码命名规范:
  • 文件名/变量/常量名都用小写,单词之间用下划线"_"分隔
  • #define 宏定义全大写
  • 枚举常量全大写
  • 结构体/枚举类型定义用_t结尾,如mible_packet_t。
  1. 头文件#define保护
  • 所有头文件都应该使用#define来防止头文件被多重包含, 命名格式当是: ___H_
  1. include的路径及顺序(切记不要用相对路径):
  • 该源文件对应的.h文件(放在最前面可以通过编译器避免隐式include)
  • C 系统文件
  • C++ 系统文件
  • 其他库的.h文件
  • 本项目内.h文件

你可能感兴趣的:(我的博客,代码规范,c++)