代码规范试用稿培训课件.pptVIP

注释规范 写注释时的注意事项 注释不是白话文翻译，不要鹦鹉学舌 注释不是教科书，不要把别人当成初学者 注释不是标准库函数参考手册 注释不是越多越好，不好的注释等于垃圾 不写做了什么，写想做什么 边写代码边注释 修改代码同时修改注释 注释规范 可灵活运用的一些规则 注释可长可短，但应画龙点睛，重点加在语义转折处 简单的函数可以用一句话简单说明 //两数交换 void Swap(int *x, int *y) 内部使用的函数可以简单注释，供别人使用的函数必须严格注释，特别是入口参数和出口参数 Readme的书写内容 主要用来记录 日期、创建者、内容等 每次重大功能的添加、修改 具体格式： 日期—TAB—创建者—TAB—内容 日期:2003.1.21 创建者:XXX 内容:实例工程 日期—TAB—修改的文件名—TAB—修改的功能 对修改后的功能和原理的说明 …… 日期—TAB—修改的文件名—TAB—修改的功能 对修改后的功能和原理的说明 类的版式 “以数据为中心”的版式 private类型的数据写在前面，public类型的数据写在后面 关注类的内部结构 “以行为为中心”的版式 public类型的数据写在前面， private类型的数据写在后面 关注的是类应该提供什么样的接口（或服务） 提倡后者 因为用户最关心的是接口 标识符命名规则 按照执行级别分为： 共性规则 必须执行 简化规则 建议采用 可选规则 灵活运用 标识符命名的共性规则 直观可以拼读，见名知意，不必解码 最好采用英文单词或其组合，切忌用汉语拼音 尽量避免出现数字编号 不要出现仅靠大小写区分的相似的标识符 不要出现名字完全相同的局部变量和全局变量 用正确的反义词组命名具有互斥意义的变量或相反动作的函数 int minValue; int maxValue; int GetValue(…); int SetValue(…); 标识符命名的共性规则 尽量与所采用的操作系统或开发工具的风格保持一致 在Linux/Unix平台 习惯用“小写加下划线” function_name variable_Name Windows风格 大小写混排的单词组合而成 FunctionName variableName Windows应用程序命名规则 Microsoft公司的Hungarian Notation 主要思想 在变量和函数名前加上前缀，用于标识变量的数据类型 [限定范围的前缀] + [数据类型前缀] + [有意义的英文单词] 限定范围的前缀 静态变量前加前缀s_ ，表示static 全局变量前加前缀g_ ，表示global 类内的成员函数m_ 默认情况为局部变量 数据类型前缀 ch 字符变量前缀 i 整型变量前缀 f 实型变量前缀 p 指针变量前缀 Windows应用程序命名规则 缺点 烦琐 例如 int i, j, k; float x, y, z; 若采用匈牙利命名规则，则应写成 int iI, iJ, ik; //前缀i表示int类型 float fX, fY, fZ; //前缀f表示float类型 简化的Windows应用程序命名规则 变量名形式 小写字母开头 “名词”或者“形容词+名词” 如oldValue, newValue等 函数名形式 大写字母开头 “动词”或者“动词+名词”（动宾词组） 如GetValue(), SetValue()等 宏和const常量全用大写字母，并用下划线分割单词 #define ARRAY_LEN 10 const int MAX_LEN = 100; 灵活运用的命名规则 限定范围的前缀与数据类型前缀可要可不要 无特殊意义的循环变量可以直接定义成i,j,k等单字母变量 表达式规则 尽量简单，不要太复杂 不要多用途 a = i++ + i++ + i++; printf(%d, %d, %d, i++, i++, i++); 不要与数学表达式混淆 if (abc) 不表示 if ((ab)(bc)) 无需背诵的规则 运算符优先级 先算括号 用括号确定表达式的操作顺序，避免使用默认的优先级 库函数用法 会查联机帮助、手册最重要 需要考虑移植性的问题 不同平台，不同编译器，可能会迥然不同 凡是需要字节数的地方，一律用sizeof获得 与零比较的规则 布尔变量与零比较 不应写成 if (flag == 0) if (flag != 0) 应写成 if (flag) //表示flag为真 if (!flag) //表示flag为假 与零比较的规则 整型变量与零比较 不应写成 if (value) //容易误解为布尔变量 if (!value) 应写成 if (value