C语言编码规范.docVIP

C语言编码规范 范围 本标准规定了C语言的软件程序编码规范，适用于BSC软件部的应用软件、通用平台软件以及底层驱动软件，但用特殊的协议软件工具SDT生成的C代码可不遵守此规范。 命名 命名包括模块名、常量名、标号名、函数名等。这些名字应该能反映它所代表的实际意义，使其能够见名知义，有助于对程序功能的理解。 基本要求 格式 使用英文，用完整单词表示，尽量不采用缩写。 命名的长度 一般不要过长或过短。过长会增加工作量，过短则可能有命名冲突。函数命名、驱动中的宏命名不超过31个字母，其他命名不超过15个字母，如果超过考虑缩写或改名。如果缩写,要使用大家约定俗成的命名如msg、len、src等，以体现其原意。 在命名中使用缩写，一般采用下面三种方法： 抽取元音字母 task -- tsk user -- usr 取单词意义明显的头部 maximum -- max minimum -- min register -- reg 先用方法二后用方法一进行处理而得 temporary -- tmp remove -- rm 关于命名缩写，只有一个限制：如果缩写导致该名字的意义不明确，就不要使用它。 采用领域的规范名称 例如BSC、MAC等 常量、宏、枚举命名 全部用大写字母命名，在复合词里用下划线隔开每个词 例如 #define NON_ZERO 1 enum BoolEnums { BOOL_FALSE, BOOL_TRUE }; 变量命名 全局变量以g为前缀，其后每个单词的第一个字母大写，不使用下划线 例如： int gWindowHandle; 局部变量所有单词小写，并用下划线分割 例如： int timer_id char name_str[10]; 结构体/联合体成员变量以名词或名词短语命名，每个单词的第一个字母大写，不使用下划线 例如： typedef struct SystemData { int CurrentMid; int CurrentFid; int CurrentPid; } SystemDataType; 指针变量以ptr为后缀，风格与其角色一致，并且每行定义一个 例如 全局指针变量int* gListPtr 局部指针变量int* list_ptr; 数据结构成员变量int* ListPtr; 循环变量可采用i, j, k等不受上述规则限制 函数命名 文件内函数命名首个字母小写，其他单词第一个字母大写 例如 int createTimer(); 文件间接口函数以小写单词命名，并用下划线隔开每个词 例如 int icp_f_code(); 第一个单词尽量采用主动的动词 例如 void transfer_message(); 类型命名 以模块名缩写（全部大写，用下划线分开）作为前缀，防止命名冲突 例如 struct BSC_SduSetupReq { }; 自定义的类型以名词或名词短语命名，每个单词的第一个字母大写，不使用下划线。枚举类型以复数结尾，结构体必须采用typedef方式定义，在类型名后加后缀Type，以示其为类型 例如 enum Days {SUNDAY, MONDAY, TUESDAY, … , SATURDAY}; typedef struct RouteTable { } RouteTableType; 规则 基本原则 不允许把多个短语句写在一行中，即一行只写一条语句 每行不超出78个字符 嵌套的语句使用一个TAB缩进（定义为4个空格） 正确性与容错性要求 所有变量在调用前必须被初始化 对所有的外部输入，必须进行合法性检查，尤其是作为数组下标或指针偏移量的值 文件编译后不能有Warning 慎重使用强制类型转换，不同类型变量间赋值必须使用显式类型转换 例如 float f; int i; f = (float)i; 结构化要求 尽量不使用goto语句 尽量不使用条件表达式(?:)语句 避免从循环引出多个出口，小心使用continue和break 除了循环控制语句，不得使用逗号表达式 禁止使用超过两级的指针 一个模块的全局变量必须定义在一个结构体中，以与其他模块区分 do while尽量改成while类型，因do while把exit条件放到最后判断，有可能产生未及时判断错误 大括号策略 左括号位于关键字的正下方，与上一行缩进保持一致 每个括号单独占一行，并且缩进保持一致 if, else if, else, while, do…while, for语句块必须使用{}括起语句块内保持相同的缩进 例如 if (conditi