一、命名约定——变量名
(1)公共对象(变量)与公共函数(即具有全局性)应使用指示符作为前缀(即源代码文件)。
(2)所有对象均由字母、数字、下划线构成。若是文件内部对象,只能采用小写字母。若是全局对象(即外部链接)应加前缀。
(3)所有文件范围对象应在源代码文件中声明。所有全局范围的对象应在头文件中声明。定义类型适用的最小可能范围。
(4)对不同的或冗余文件将使用由下划线与单个字母组成的后缀(eg:tim_get_time_A.c,tim_get_time_B.c)。
(5)函数参数列表名称:函数内部的变量名应被维持至函数边界。
二、命名约定——函数名
(1)函数名由字母、数字、下划线构成,尽量使用由单个动词和单个名词组成的名字。
(2)面向对象的相关函数应含有动词,后跟下划线与object_name(对象名)。
(3)函数名前缀”is”或”is_”应保留个布尔型函数以专门返回boolean_t等布尔型。例如:isflower()。
三、命名约定——常量名
(1)声明(即单独一行无参数申明#define),利用类型限定如const的对象与枚举量将被指为常量。
(2)整型、字符型与浮点型常量命令,无论其使用范围,均可由下划线与字母构成:大写字母与数字,小写字母与数字并以”_k”为后缀。
(3)后缀”_k”被保留用于整型、字符型与浮点型常量命名
(4)使用符号量代替文字提高代码的可读性与维护性
例如:
If(speed_value=234)
可重写为:
static const uint16 speed_max_k=234;
If(speed_value=speed_max_k);
(5)枚举常量应由大写字母与下划线字符构成
例如:
typedef enum {BLACK,RED,GREEN} font_color_t;
四、命名约定——宏名
五、命名约定——类型别名
类型别名的命名应由小写字母与下划线构成。所有的类名应具有后缀”_t”(非union型)与”_u”(union型)。后缀”_t”与”_u”保留给类型别名。
六、命名约定——成员名
结构体与联合体名应遵循与变量名相同的命名约定
七、保留关键字
保留字或关键词的使用限定是明确的。
“_g”后缀保留给全局变量,可选。
“_k”后缀保留给整型、字符型、浮点型常量名,必选。
“_t”后缀保留给typedef申明不包括union型,必选。
“_u”后缀保留给typedef申明union型,必选。
备注:文档中记录的C语言编写条例可作为程序设计参考,来进行程序的编写设计,提高程序代码编写质量,增强代码可读性。