C语言代码规范.ppt

深圳市中兴通讯股份有限公司 C语言代码规范 主要内容 表达式 类型和数据 函数 控制状态 内存分配 文件组织 布局和风格 命名 注释 其他 为什么需要代码规范 增强可读性 减少错误 提高可维护性 增加可移植性 增强可配置性 方便调试 为测试工具的验证提供必要条件 表达式 表达式 表达式 表达式 表达式 表达式 表达式 类型和数据 类型和数据 类型和数据 类型和数据 类型和数据 数据和类型 数据和类型 数据和类型 数据和类型 数据和类型 数据和类型 数据和类型 数据和类型 数据和类型 数据和类型 数据和类型 数据和类型 数据和类型 数据和类型 建议：使用const或者enum定义常量，减少＃define的是有使用 好的例子： enum {max_size = 1000}; void func(void) { unsigned int some_array[max_size]; const unsigned int lower_limit = 0; const unsigned int upper_limit = max_size; unsigned int index; for (index = lower_limit; index upper_limit; index++) { … } } 数据和类型 不要使用神秘数，必须使用具有意义的值代替。 不能修改字符串常量。如果需要使用可以修改的字符串，必须使用数组。 数据和类型 不要对指针使用操作符!，，，||，不要对两个指针使用加法。 对相同的数组使用比较和减法。 数据和类型 建议：减少指向指针的指针，以免降低程序的可读性。 数据和类型 当声明函数指针式，使用typedef 好的例子: unsigned int str_cmp(char*, char*); /* 函数原型 */ unsigned int num_cmp(char*, char*); /* 函数原型 */ /* 新的数据类型Pointer_to_comparefunction: 指向一个函数，它具有两个char*参数，并返回unsigned int的结果*/ typedef unsigned int (*Pointer_to_comparefunction)(char*, char*); Pointer_to_comparefunction str_cmp, num_cmp; /* quicksort使用了这个新定义的数据类型*/ void quicksort(Pointer_to_comparefunction, other arguments); 如果不使用新的数据类型定义，则可读性不强： void quicksort(unsigned int (*cmp_ptr)(char*, char*), other arguments); 数据和类型 对多维数组只使用下标记号 例子： WORD32 x[5][30]; WORD32 i; i = x[2][7]; /* OK */ i = *(*(x + 2) + 7); /* BAD */ 数据和类型 函数蚕室不要声明为数组，只是用指针标记。 函数 避免函数参数个数，通常来说6个以上的参数就可以被视为不合理。 函数 在函数原型中定义参数名字，并且和函数定义中的相同。 函数 建议：不要在用户定义的函数中使用可变长的参数列表。 建议：减少定义带有void*的参数和/或返回void*值的函数。 函数 如果函数返回非void类型的结果，必须在任何函数可能返回的地方使用明确地带有表达式的return语句。 不好的例子： WORD32 some_function(WORD32 i, WORD32 j) { if (i == 1) { return 1; } else { if (j == 1) { return 0; } } /* return missing here */ } 函数 函数体中不可有不可达的代码 宏 给宏的体和参数的表达式都加上括号 好的例子： #define MULT(a,b) ((a) * (b))/* 考虑:MULT(100,4+5) */ #define ODD(x) ((x) 1) 控制语句 尽量避免使用goto语句 不能使用longjumps 控制语句 使用break推出循环，以避免使用一些标志值 好的例子： do { if (something) { ... brea