【转】C语言常用代码规范

只看该作者 · 2017-2-25 12:15

1、类型的宏替换
1）要求
要求用“#ifndef”判断是否之前被定义过。
2）举例
[cpp] view plain copy

2、宏定义
1）要求
①宏全为大写的英文字母。
②宏的名称应能读出其功能作用。
2）举例
[cpp] view plain copy

3、变量
1）要求
①变量名称前的字母含义要求如下
g：global全局。
a：array数组。
s：static静态。
c：const不变常数。
n：变量。
p：指针。
②变量的名称应能读出其功能作用。

2）举例
[cpp] view plain copy

3、if
1）要求
①“{”与“}”要对齐。
②if与else的上方要注释。
2）举例
[cpp] view plain copy

4、switch
1）要求
①switch、case、default上都要注释。
②每种情况的具体处理由“{}”包含。
2）举例
[cpp] view plain copy

5、文件注释
1）要求
至少要包含文件名称、文件作用说明、编码人、最后修改时间。
2）举例
①源文件
[cpp] view plain copy

//******************************************************************************
//name: GUA_RF_Communication.c
//introduce: 香瓜的通信协议
//author: 甜甜的大香瓜
//email: 897503845@qq.com
//QQ group 香瓜BLE之CC2541(127442605)
//changetime: 2016.12.08
//******************************************************************************

②头文件
[cpp] view plain copy

//******************************************************************************
//name: GUA_RF_Communication.h
//introduce: 香瓜的通信协议的头文件
//author: 甜甜的大香瓜
//email: 897503845@qq.com
//QQ group 香瓜BLE之CC2541(127442605)
//changetime: 2016.12.08
//******************************************************************************

6、函数注释
1）要求
至少要包含函数名称、函数作用说明、形参含义、返回值含义、编码人、最后修改时间。
2）举例

[cpp] view plain copy

//******************************************************************************
//name: GUA_RF_Communication_Judgment
//introduce: RF的通信数据判断
//parameter: npGUA_Receive: 接收缓冲区首地址
//return: true: 数据包正确
// false: 数据包错误
//author: 甜甜的大香瓜
//email: 897503845@qq.com
//QQ group 香瓜BLE之CC2541(127442605)
//changetime: 2016.12.08
//******************************************************************************
GUA_U8 GUA_RF_Communication_Judgment(GUA_U8 *npGUA_Receive)
{
……
}