单片机工程编写规范

如下规范仅限于本人自己做记录和参考，有误之处请大家指正。
变量名：采用小写字母，单词之间用下划线连接。例如：int my_variable;

常量名：全部大写字母，单词之间用下划线连接。例如：#define MAX_VALUE 100;

函数名：采用首字母大写驼峰命名法，单词之间用下划线连接。例如：void MyFunction();

结构体名：采用驼峰命名法，首字母大写。例如：typedef struct MyStruct { … } MyStruct;

枚举名：采用驼峰命名法，首字母大写。例如：enum MyEnum { … };

宏定义名：全部大写字母，单词之间用下划线连接。例如：#define PI 3.1415926;

文件名：全部小写字母，单词之间用下划线连接。例如：my_file.c;

类型定义名：采用驼峰命名法，首字母大写。例如：typedef int MyInt;

成员变量名：采用小写字母，单词之间用下划线连接。例如：struct MyStruct { int my_member_variable; };

局部变量名：采用驼峰命名法，单词之间用下划线连接。例如：int myLocalVariable;
char类型的变量以c为前缀
short类型的变量以s为前缀
long类型的变量以l为前缀
float类型的变量以f为前缀
double类型的变量以d为前缀
enum变量以e为前缀
其他类型（如结构体）以 x 为前缀
point有一个额外的前缀p, 例如short类型的指针前缀为ps
unsigned类型的变量有一个额外的前缀u, 例如无符号short类型的变量前缀为us

本规范将结合工作遇到的情况持续更新。
1.模块化文件格式
（.h）文件

#ifndef __INCLUDE_H
#define __INCLUDE_H

/*************************** Includes ***************************/

/*************************** extern define  ********************/

/*************************** extern variables  *****************/

/*************************** extern function prototypes  *******/

#endif /*__INCLUDE_H*/

（.c）文件

/*
 * @Author: xxxx
 * @Date: xxxx
 * @LastEditors: xxxx
 * @LastEditTime: xxxx
 * @Description: 
 */

/*************************** Includes ***************************/

/*************************** Private define  ********************/

/*************************** Private variables  *****************/

/*************************** Private function prototypes  *******/

/*************************** Public variables  ******************/

/**
  * @brief  main
  * @param  void
  * @retval None.
*/
int main(void)
{
    while(1)
    {

    }
}

可以定义一个公共的头文件将所有头文件都包含在里面，以后每次写C文件就可以值包含一个头文件。

#ifndef __PUBLIC_H_
#define __PUBLIC_H_

#include "led.h"
#include "pwm.h"
#include "key.h"

#endif /*__PUBLIC_H_*/

2.新定义的类型命名规则
新定义的命名应该明确该对象的含义，尽量使用全部大写，单词之间用下划线进行分割，成员变量使用首字母大写区分各个单词。
枚举加"_e"后缀，结构体加上"_s"后缀，共用体加上"_u"后缀，函数指针加上"_f"后缀

//枚举类型
typedef enum{
	MONDAY,
	TUESDAY,
	.....
}WEEK_e;
//结构体类型
typedef struct{
	char[10] StudentName;
	int StudentAge;
	....
}STUDENT_s;
//共用体
typedef union{
	unsigned char :1;
	unsigned char :7;
	uint8_t xxxx;
}xxx_u;
//函数指针类型
typedef (*usartEvent_Callback_f)(void);

3.命名规则（参考FreeRTOS命名规则）
3.1变量采用前缀+具体用处的形式（下划线+驼峰命名）
u表示无符号
l表示长整型
s表示短整形
c表示字符型
prv表示私有类型
p表示指针变量
x表示重定义类型

匈牙利命名法规则
a Array 数组
b BOOL (int) 布尔(整数)
by Unsigned Char (Byte) 无符号字符(字节)
c Char 字符(字节)
dw DWORD(unsigned long) 双字(无符号长整数)
f Flags 标志(一般是有多位的数值)
fn Function 函数
g global 全局的
p Pointer 指针
m Data member of a class 一个类的数据成员
v void 空
s 字符串型

uint8_t ucUart_SendData;//表示无符号串口发送8位数据
uint16_t usUart_SendData;//表示无符号串口发送16位数据
uint8_t *pucUart_Buff;//表示指向串口缓存的指针
size_t xSize;//表示重定义类型
static uint8_t prvData;//表示私有变量

3.2函数采用具体设备+作用（下划线+驼峰命名）

void Uart_Init(void);//串口初始化
void Uart_SednData(uint8_t Data);//串口发送数据

3.3宏定义命名
尽量采用全部大写的形式，C的宏只能扩展为用大括号括起来的初始化、常量、小括号括起来的表达式、类型限定符、存储类标识符或do-while-zero 结构。

 #define   PI 3.14159F
 #define  CLOCK (XSTAL / 16)
 #define   INIT(value)  { (value), 0, 0 } 

如果某一个宏是经常被使用的，则可以使用文件名（小写）+宏名的方式命名

#define configMAX_DELAY	1	//表示在config.h头文件定义

4.在定义函数宏时，每个参数实例都应该以小括号括起来。

 #define  abs (x) ( ( (x) >= 0 ) ? (x) : -(x) )
 #define   READ_TIME_32() \
 do  { \
	DISABLE_INTERRUPTS(); \
	time_now = (INT32U) TIMER_HI << 16; \
	time_now = time_now | (INT32U) TIMER_LO; \
	ENABLE_INTERRUPTS(); \
} while(0)   //分号在使用这个宏定义时后面加上

5.使用宏时，不允许参数数值发生变化。

//错误用法
b = SQUARE(a++);           /*结果：a = 7，即执行了两次增。*/

//正确用法
b = SQUARE(a);
a++;                                      /*结果：a = 6，即只执行了一次增*/