写出干净易懂的代码需要遵循一定的编码规范,下面是目前总结的一些经验,持续补充加强:
1 函数参数统一Camel 大小写方式,传值如TimeCost, 指针采用* pTimeCost表示;
2 局部变量统一小写,用下划线隔开,采用time_cost方式表达;如为指针,则采用* p_time_cost方式表达;
3 结构体/枚举/整形int等变量统一Camel大小写方式,如
typedef struct TimeCost
{
int TimeCost;
void * pTimeCost;
}TimeCost;
4 函数命名方式:
明确标明参数输入IN/OUT特性,可以采用#define IN #define OUT方式;
函数名 大小写;前缀+模块名+功能名
修饰符 返回类型 函数名 (IN xx , OUT xx)
5 封装类型定义,不要一直使用int char,double等定义,方便移植;