嵌入式C语言编程规范

• 命名规范

  变量命名

• 使用有意义的名字，该名字应反映变量的用途或其代表的值
• 避免使用单个字符名字，除非是常见的循环变量如i, j。
• 使用小写字母，并在多个单词间使用下划线连接。例如：sensor_value，update_interval。
• 使用g_前缀来标识全局变量。例如：g_system_state。
• 使用s_前缀来标识静态变量。例如：s_internal_counter。
• 使用st_前缀来标识结构体变量。例如：st_date。
• 使用p_前缀来标识指针。例如：p_num。
• 使用p_st_前缀来标识结构体指针。例如p_st_date。
• 常量和宏定义使用全大写字母，并用下划线分隔单词。例如：MAX_VALUE, TIMER_INTERVAL。
• 结构体类型声明需要使用“_Struct”后缀，例如Date_Struct
• 枚举类型名称使用大写字母开始，例如：ColorType。
• 枚举值使用全大写字母，并用下划线分隔单词，例如：COLOR_RED, COLOR_BLUE。
• 内部变量都要加static关键字。

• 函数命名

• 函数名称应描述其功能或执行的操作。
• 使用{分层}_{模块}_{功能}作为函数名称，分层详见分层定义，模块首字母大写，功能使用首字母大写的驼峰命名。特殊名词全部大写。
• 返回布尔值的函数，其名称应该是一个问题或断言。例如：IsButtonPressed(), HasDataArrived()。
• 为属性/变量获取值的函数使用Get前缀。例如：GetSpeed()。
• 为属性/变量设置值的函数使用Set前缀。例如：SetSpeed(int speed)。
• 函数应尽量短小，并执行单一功能。这样可以提高代码的可读性和可维护性。
• 内部函数都要加static关键字。

• 文件命名

• 使用{分层}_{模块}作为文件名称，分层详见分层定义，模块首字母大写，特殊名词全部大写。
• 如果项目规模较大，头文件和源文件建议分开存放。

• 代码分层规范

• 工具函数和常规宏定义

所有特定算法、工具函数和常规宏定义。

目录：Com/

前缀：Com_

驱动层

所有与芯片直接交互的自身硬件代码，例如GPIO开关、硬件UART或ADC的驱动、计时器等。

目录：Dri/

前缀：Dri_

​​​​​​​接口层

位于驱动层之上，通过标准接口（GPIO、UART、IIC、SPI等）驱动的外部硬件代码。如果没有外部硬件设备，可以不用这一层。

目录：Int/

前缀：Int_

​​​​​​​中间层

提供更高级的服务，如操作系统、文件系统、通信协议栈等。这层通常用于复杂的单片机项目，例如使用RTOS的项目。简单的项目可以不用这一层。

目录：Mid/

前缀：Mid_

​​​​​​​应用层

包含应用程序的主要逻辑。该层应只与上面的中间件层或接口层交互，尽量不直接访问驱动层。

目录：App/

前缀：App_

样例：