个人代码格式规范

个人代码格式规范

一、变量命名

1.宏定义命名
宏定义全部使用大写
eg:
#define UART_TX_PIN 15

2.变量命名
一般格式为： 形容词+名词,写法使用驼峰命名法。
eg:
uint8_t openFlag；
如果由两个单词组成，可以使用两种写法
uint8_t openFlag； 单词除第一个单词外首字母大写

全局变量需要在变量前加g,
静态变量需要在变量前加s,
结构体变量需要在后面加_t标志这是一个结构体变量。
eg:
uint8_t g_openFlag;

static uint8_t s_openFlag;

typedef struct devCfg{
uint8_t dev_id; //设备ID
uin8_t dev_time; //设备时间
}devCfg_t;

除去一些通用常用的单词可以缩写外，其他函数均不缩写，可缩写的单词部分如下所示：

3.函数命名

一般以函数将要进行的动作来作为名字，函数名命名普遍为：动词+名词,函数单词首字母均大写或者使用下划线分开。
eg:
void get_battery_value(void); //获得电池电量
void GetBatteryValue(void);//获得电池电量
为与变量区分最好是使用不同的方法。

4.文件命名
全部使用小写字母命名。
eg:
filename.c

二、注释

2.1函数注释

/*****************************************************

• @param: 参数
• @return: 返回值
• @function: 功能
• @author: 作者
• @date: 日期
• @note: 近期改动注释
  ****************************************************/
  注释格式：param:参数 ，return：返回值 function:功能，author：作者 date:日期，note:近期改动注释

2.2文件注释

/*****************************************************
*@filename: dooor_server.c
*@description: 实现开门逻辑
*@author: Tslong
*@version：v1.0
*@date：2020/9/10
*@note: 第一次提交
****************************************************/

2.3全局变量与结构体注释

eg:
static uint8_t s_openFlag; //开关标志位，用于判断开关是否按下

typedef struct devCfg{
uint8_t dev_id; //设备ID
uin8_t dev_time; //设备时间
}devCfg_t; // 设备信息结构体