C++代码审查---参考林锐高质量C/C++

功能模块名称 
审查人 审查日期 
代码名称 代码作者 
文件结构
重要性      审查项结论
                头文件和定义文件的名称是否合理? 
 头文件和定义文件的目录结构是否合理? 
 版权和版本声明是否完整? 
重要头文件是否使用了 ifndef/define/endif 预处理块? 
 头文件中是否只存放“声明”而不存放“定义” 
   
程序的版式
重要性      审查项结论
 空行是否得体? 
 代码行内的空格是否得体? 
 长行拆分是否得体? 
 “{” 和 “}” 是否各占一行并且对齐于同一列? 
重要一行代码是否只做一件事?如只定义一个变量,只写一条语句。 
重要If、for、while、do等语句自占一行,不论执行语句多少都要加 “{}”。 
重要在定义变量(或参数)时,是否将修饰符 * 和 & 紧靠变量名?注释是否清晰并且必要? 
重要注释是否有错误或者可能导致误解? 
重要类结构的public, protected, private顺序是否在所有的程序中保持一致? 
   
命名规则 
重要性      审查项结论
重要命名规则是否与所采用的操作系统或开发工具的风格保持一致? 
 标识符是否直观且可以拼读? 
 标识符的长度应当符合“min-length && max-information”原则? 
重要程序中是否出现相同的局部变量和全部变量? 
 类名、函数名、变量和参数、常量的书写格式是否遵循一定的规则? 
 静态变量、全局变量、类的成员变量是否加前缀? 
   
表达式与基本语句 
重要性      审查项结论
重要如果代码行中的运算符比较多,是否已经用括号清楚地确定表达式的操作顺序? 
 是否编写太复杂或者多用途的复合表达式? 
重要是否将复合表达式与“真正的数学表达式”混淆? 
重要是否用隐含错误的方式写if语句? 例如 
 (1)将布尔变量直接与TRUE、FALSE或者1、0进行比较。 
 (2)将浮点变量用“==”或“!=”与任何数字比较。 
 (3)将指针变量用“==”或“!=”与NULL比较。 
 如果循环体内存在逻辑判断,并且循环次数很大,是否已经将逻辑判 
 断移到循环体的外面? 
重要Case语句的结尾是否忘了加break? 
重要是否忘记写switch的default分支? 
重要使用goto 语句时是否留下隐患? 例如跳过了某些对象的构造、变量的初始化、重要的计算等。 
   
常量 
重要性      审查项结论
 是否使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串? 
 在C++ 程序中,是否用const常量取代宏常量? 
重要如果某一常量与其它常量密切相关,是否在定义中包含了这种关系? 
 是否误解了类中的const数据成员?因为const数据成员只在某个对象 
 生存期内是常量,而对于整个类而言却是可变的。 
   
函数设计 
重要性      审查项结论
 参数的书写是否完整?不要贪图省事只写参数的类型而省略参数名字。 
 参数命名、顺序是否合理? 
 参数的个数是否太多? 
 是否使用类型和数目不确定的参数? 
 是否省略了函数返回值的类型? 
 函数名字与返回值类型在语义上是否冲突? 
重要是否将正常值和错误标志混在一起返回?正常值应当用输出参数获得,而错误标志用return语句返回。 
重要在函数体的“入口处”,是否用assert对参数的有效性进行检查? 
重要使用滥用了assert? 例如混淆非法情况与错误情况,后者是必然存在的并且是一定要作出处理的。 
重要return语句是否返回指向“栈内存”的“指针”或者“引用”? 
 是否使用const提高函数的健壮性?const可以强制保护函数的参数、返回值,甚至函数的定义体。“Use const whenever you need” 
   
内存管理 
重要性      审查项结论
重要用malloc或new申请内存之后,是否立即检查指针值是否为NULL?(防止使用指针值为NULL的内存) 
重要是否忘记为数组和动态内存赋初值?(防止将未被初始化的内存作为右值使用) 
重要数组或指针的下标是否越界? 
重要动态内存的申请与释放是否配对?(防止内存泄漏) 
重要是否有效地处理了“内存耗尽”问题? 
重要是否修改“指向常量的指针”的内容? 
重要是否出现野指针?例如(1)指针变量没有被初始化;(2)用free或delete释放了内存之后,忘记将指针设置为NULL。 
重要是否将malloc/free 和 new/delete 混淆使用? 
重要malloc语句是否正确无误?例如字节数是否正确?类型转换是否正 确? 
重要在创建与释放动态对象数组时,new/delete的语句是否正确无误? 
   
C++ 函数的高级特性 
重要性      审查项结论
 重载函数是否有二义性? 
重要是否混淆了成员函数的重载、覆盖与隐藏? 
 运算符的重载是否符合制定的编程规范? 
 是否滥用内联函数?例如函数体内的代码比较长,函数体内出现循环。 
重要是否用内联函数取代了宏代码? 
   
类的构造函数、析构函数和赋值函数
重要性      审查项结论
重要是否违背编程规范而让C++ 编译器自动为类产生四个缺省的函数: 
 (1)缺省的无参数构造函数; 
 (2)缺省的拷贝构造函数; 
 (3)缺省的析构函数; 
 (4)缺省的赋值函数。 
重要构造函数中是否遗漏了某些初始化工作? 
重要是否正确地使用构造函数的初始化表? 
重要析构函数中是否遗漏了某些清除工作? 
 是否错写、错用了拷贝构造函数和赋值函数? 
重要赋值函数一般分四个步骤: 
 (1)检查自赋值; 
 (2)释放原有内存资源; 
 (3)分配新的内存资源,并复制内容; 
 (4)返回 *this。是否遗漏了重要步骤?         
重要是否正确地编写了派生类的构造函数、析构函数、赋值函数? 
 注意事项: 
 (1)派生类不可能继承基类的构造函数、析构函数、赋值函数。 
 (2)派生类的构造函数应在其初始化表里调用基类的构造函数。 
 (3)基类与派生类的析构函数应该为虚(即加virtual关键字)。 
 (4)在编写派生类的赋值函数时,注意不要忘记对基类的数据成员重新赋值 
   
类的高级特性
重要性      审查项结论
重要是否违背了继承和组合的规则? 
 (1)若在逻辑上B是A的“一种”,并且A的所有功能和属性对B而言都有意义,则允许B继承A的功能和属性。 
 (2)若在逻辑上A是B的“一部分”(a part of),则不允许B从A派生,而是要用A和其它东西组合出B。 
   
其它常见问题 
重要性      审查项结论
重要数据类型问题: 
 (1)变量的数据类型有错误吗? 
 (2)存在不同数据类型的赋值吗? 
 (3)存在不同数据类型的比较吗? 
重要变量值问题: 
 (1)变量的初始化或缺省值有错误吗? 
 (2)变量发生上溢或下溢吗? 
 (3)变量的精度够吗?         
重要逻辑判断问题: 
 (1)由于精度原因导致比较无效吗? 
 (2)表达式中的优先级有误吗? 
 (3)逻辑判断结果颠倒吗?         
重要循环问题: 
 (1)循环终止条件不正确吗? 
 (2)无法正常终止(死循环)吗? 
 (3)错误地修改循环变量吗? 
 (4)存在误差累积吗?         
重要错误处理问题: 
 (1)忘记进行错误处理吗? 
 (2)错误处理程序块一直没有机会被运行? 
 (3)错误处理程序块本身就有毛病吗?如报告的错误与实际错误不一致,处理方式不正确等等。 
 (4)错误处理程序块是“马后炮”吗?如在被它被调用之前软件已经出错。 
重要文件I/O问题: 
 (1)对不存在的或者错误的文件进行操作吗? 
 (2)文件以不正确的方式打开吗? 
 (3)文件结束判断不正确吗? 
 (4)没有正确地关闭文件吗? 
   
  • 2
    点赞
  • 15
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
前 言 6 第1章 文件结构 11 1.1 版权和版本的声明 11 1.2 头文件的结构 12 1.3 定义文件的结构 13 1.4 头文件的作用 13 1.5 目录结构 14 第2章 程序的版式 15 2.1 空行 15 2.2 代码行 16 2.3 代码行内的空格 17 2.4 对齐 18 2.5 长行拆分 19 2.6 修饰符的位置 19 2.7 注释 20 2.8 类的版式 21 第3章 命名规则 22 3.1 共性规则 22 3.2 简单的WINDOWS应用程序命名规则 23 3.3 简单的UNIX应用程序命名规则 25 第4章 表达式和基本语句 26 4.1 运算符的优先级 26 4.2 复合表达式 27 4.3 IF 语句 27 4.4 循环语句的效率 29 4.5 FOR 语句的循环控制变量 30 4.6 SWITCH语句 30 4.7 GOTO语句 31 第5章 常量 33 5.1 为什么需要常量 33 5.2 CONST 与 #DEFINE的比较 33 5.3 常量定义规则 33 5.4 类中的常量 34 第6章 函数设计 36 6.1 参数的规则 36 6.2 返回值的规则 37 6.3 函数内部实现的规则 39 6.4 其它建议 40 6.5 使用断言 41 6.6 引用与指针的比较 42 第7章 内存管理 44 7.1内存分配方式 44 7.2常见的内存错误及其对策 44 7.3指针与数组的对比 45 7.4指针参数是如何传递内存的? 47 7.5 FREE和DELETE把指针怎么啦? 50 7.6 动态内存会被自动释放吗? 50 7.7 杜绝“野指针” 51 7.8 有了MALLOC/FREE为什么还要NEW/DELETE ? 52 7.9 内存耗尽怎么办? 53 7.10 MALLOC/FREE 的使用要点 54 7.11 NEW/DELETE 的使用要点 55 7.12 一些心得体会 56 第8章 C++函数的高级特性 57 8.1 函数重载的概念 57 8.2 成员函数的重载、覆盖与隐藏 60 8.3 参数的缺省值 63 8.4 运算符重载 64 8.5 函数内联 65 8.6 一些心得体会 68 第9章 类的构造函数、析构函数与赋值函数 69 9.1 构造函数与析构函数的起源 69 9.2 构造函数的初始化表 70 9.3 构造和析构的次序 72 9.4 示例:类STRING的构造函数与析构函数 72 9.5 不要轻视拷贝构造函数与赋值函数 73 9.6 示例:类STRING的拷贝构造函数与赋值函数 73 9.7 偷懒的办法处理拷贝构造函数与赋值函数 75 9.8 如何在派生类中实现类的基本函数 75 9.9 一些心得体会 77 第10章 类的继承与组合 78 10.1 继承 78 10.2 组合 80 第11章 其它编程经验 82 11.1 使用CONST提高函数的健壮性 82 11.2 提高程序的效率 84 11.3 一些有益的建议 85 参考文献 87 附录A :C++/C代码审查表 88 附录B :C++/C试题 93 附录C :C++/C试题的答案与评分标准 97
目 录 前 言 6 第1章 文件结构 11 1.1 版权和版本的声明 11 1.2 头文件的结构 12 1.3 定义文件的结构 13 1.4 头文件的作用 13 1.5 目录结构 14 第2章 程序的版式 15 2.1 空行 15 2.2 代码行 16 2.3 代码行内的空格 17 2.4 对齐 18 2.5 长行拆分 19 2.6 修饰符的位置 19 2.7 注释 20 2.8 类的版式 21 第3章 命名规则 22 3.1 共性规则 22 3.2 简单的WINDOWS应用程序命名规则 23 3.3 简单的UNIX应用程序命名规则 25 第4章 表达式和基本语句 26 4.1 运算符的优先级 26 4.2 复合表达式 27 4.3 IF 语句 27 4.4 循环语句的效率 29 4.5 FOR 语句的循环控制变量 30 4.6 SWITCH语句 30 4.7 GOTO语句 31 第5章 常量 33 5.1 为什么需要常量 33 5.2 CONST 与 #DEFINE的比较 33 5.3 常量定义规则 33 5.4 类中的常量 34 第6章 函数设计 36 6.1 参数的规则 36 6.2 返回值的规则 37 6.3 函数内部实现的规则 39 6.4 其它建议 40 6.5 使用断言 41 6.6 引用与指针的比较 42 第7章 内存管理 44 7.1内存分配方式 44 7.2常见的内存错误及其对策 44 7.3指针与数组的对比 45 7.4指针参数是如何传递内存的? 47 7.5 FREE和DELETE把指针怎么啦? 50 7.6 动态内存会被自动释放吗? 50 7.7 杜绝“野指针” 51 7.8 有了MALLOC/FREE为什么还要NEW/DELETE ? 52 7.9 内存耗尽怎么办? 53 7.10 MALLOC/FREE 的使用要点 54 7.11 NEW/DELETE 的使用要点 55 7.12 一些心得体会 56 第8章 C++函数的高级特性 57 8.1 函数重载的概念 57 8.2 成员函数的重载、覆盖与隐藏 60 8.3 参数的缺省值 63 8.4 运算符重载 64 8.5 函数内联 65 8.6 一些心得体会 68 第9章 类的构造函数、析构函数与赋值函数 69 9.1 构造函数与析构函数的起源 69 9.2 构造函数的初始化表 70 9.3 构造和析构的次序 72 9.4 示例:类STRING的构造函数与析构函数 72 9.5 不要轻视拷贝构造函数与赋值函数 73 9.6 示例:类STRING的拷贝构造函数与赋值函数 73 9.7 偷懒的办法处理拷贝构造函数与赋值函数 75 9.8 如何在派生类中实现类的基本函数 75 9.9 一些心得体会 77 第10章 类的继承与组合 78 10.1 继承 78 10.2 组合 80 第11章 其它编程经验 82 11.1 使用CONST提高函数的健壮性 82 11.2 提高程序的效率 84 11.3 一些有益的建议 85 参考文献 87 附录A :C++/C代码审查表 88 附录B :C++/C试题 93 附录C :C++/C试题的答案与评分标准 97
前 言... 6 第1章 文件结构... 11 1.1 版权和版本的声明... 11 1.2 头文件的结构... 12 1.3 定义文件的结构... 13 1.4 头文件的作用... 13 1.5 目录结构... 14 第2章 程序的版式... 15 2.1 空行... 15 2.2 代码行... 16 2.3 代码行内的空格... 17 2.4 对齐... 18 2.5 长行拆分... 19 2.6 修饰符的位置... 19 2.7 注释... 20 2.8 类的版式... 21 第3章 命名规则... 22 3.1 共性规则... 22 3.2 简单的Windows应用程序命名规则... 23 3.3 简单的Unix应用程序命名规则... 25 第4章 表达式和基本语句... 26 4.1 运算符的优先级... 26 4.2 复合表达式... 27 4.3 if 语句... 27 4.4 循环语句的效率... 29 4.5 for 语句的循环控制变量... 30 4.6 switch语句... 30 4.7 goto语句... 31 第5章 常量... 33 5.1 为什么需要常量... 33 5.2 const 与 #define的比较... 33 5.3 常量定义规则... 33 5.4 类中的常量... 34 第6章 函数设计... 36 6.1 参数的规则... 36 6.2 返回值的规则... 37 6.3 函数内部实现的规则... 39 6.4 其它建议... 40 6.5 使用断言... 41 6.6 引用与指针的比较... 42 第7章 内存管理... 44 7.1内存分配方式... 44 7.2常见的内存错误及其对策... 44 7.3指针与数组的对比... 45 7.4指针参数是如何传递内存的?... 47 7.5 free和delete把指针怎么啦?... 50 7.6 动态内存会被自动释放吗?... 50 7.7 杜绝“野指针”... 51 7.8 有了malloc/free为什么还要new/delete ?... 52 7.9 内存耗尽怎么办?... 53 7.10 malloc/free 的使用要点... 54 7.11 new/delete 的使用要点... 55 7.12 一些心得体会... 56 第8章 C++函数的高级特性... 57 8.1 函数重载的概念... 57 8.2 成员函数的重载、覆盖与隐藏... 60 8.3 参数的缺省值... 63 8.4 运算符重载... 64 8.5 函数内联... 65 8.6 一些心得体会... 68 第9章 类的构造函数、析构函数与赋值函数... 69 9.1 构造函数与析构函数的起源... 69 9.2 构造函数的初始化表... 70 9.3 构造和析构的次序... 72 9.4 示例:类String的构造函数与析构函数... 72 9.5 不要轻视拷贝构造函数与赋值函数... 73 9.6 示例:类String的拷贝构造函数与赋值函数... 73 9.7 偷懒的办法处理拷贝构造函数与赋值函数... 75 9.8 如何在派生类中实现类的基本函数... 75 9.9 一些心得体会... 77 第10章 类的继承与组合... 78 10.1 继承... 78 10.2 组合... 80 第11章 其它编程经验... 82 11.1 使用const提高函数的健壮性... 82 11.2 提高程序的效率... 84 11.3 一些有益的建议... 85 参考文献... 87 附录A :C++/C代码审查表... 88 附录B :C++/C试题... 93 附录C :C++/C试题的答案与评分标准... 97
高质量C++编程指南(林锐)DOC版和pdf的合集 目 录 前 言 6 第1章 文件结构 11 1.1 版权和版本的声明 11 1.2 头文件的结构 12 1.3 定义文件的结构 13 1.4 头文件的作用 13 1.5 目录结构 14 第2章 程序的版式 15 2.1 空行 15 2.2 代码行 16 2.3 代码行内的空格 17 2.4 对齐 18 2.5 长行拆分 19 2.6 修饰符的位置 19 2.7 注释 20 2.8 类的版式 21 第3章 命名规则 22 3.1 共性规则 22 3.2 简单的WINDOWS应用程序命名规则 23 3.3 简单的UNIX应用程序命名规则 25 第4章 表达式和基本语句 26 4.1 运算符的优先级 26 4.2 复合表达式 27 4.3 IF 语句 27 4.4 循环语句的效率 29 4.5 FOR 语句的循环控制变量 30 4.6 SWITCH语句 30 4.7 GOTO语句 31 第5章 常量 33 5.1 为什么需要常量 33 5.2 CONST 与 #DEFINE的比较 33 5.3 常量定义规则 33 5.4 类中的常量 34 第6章 函数设计 36 6.1 参数的规则 36 6.2 返回值的规则 37 6.3 函数内部实现的规则 39 6.4 其它建议 40 6.5 使用断言 41 6.6 引用与指针的比较 42 第7章 内存管理 44 7.1内存分配方式 44 7.2常见的内存错误及其对策 44 7.3指针与数组的对比 45 7.4指针参数是如何传递内存的? 47 7.5 FREE和DELETE把指针怎么啦? 50 7.6 动态内存会被自动释放吗? 50 7.7 杜绝“野指针” 51 7.8 有了MALLOC/FREE为什么还要NEW/DELETE ? 52 7.9 内存耗尽怎么办? 53 7.10 MALLOC/FREE 的使用要点 54 7.11 NEW/DELETE 的使用要点 55 7.12 一些心得体会 56 第8章 C++函数的高级特性 57 8.1 函数重载的概念 57 8.2 成员函数的重载、覆盖与隐藏 60 8.3 参数的缺省值 63 8.4 运算符重载 64 8.5 函数内联 65 8.6 一些心得体会 68 第9章 类的构造函数、析构函数与赋值函数 69 9.1 构造函数与析构函数的起源 69 9.2 构造函数的初始化表 70 9.3 构造和析构的次序 72 9.4 示例:类STRING的构造函数与析构函数 72 9.5 不要轻视拷贝构造函数与赋值函数 73 9.6 示例:类STRING的拷贝构造函数与赋值函数 73 9.7 偷懒的办法处理拷贝构造函数与赋值函数 75 9.8 如何在派生类中实现类的基本函数 75 9.9 一些心得体会 77 第10章 类的继承与组合 78 10.1 继承 78 10.2 组合 80 第11章 其它编程经验 82 11.1 使用CONST提高函数的健壮性 82 11.2 提高程序的效率 84 11.3 一些有益的建议 85 参考文献 87 附录A :C++/C代码审查表 88 附录B :C++/C试题 93 附录C :C++/C试题的答案与评分标准 97
林锐博士在编程质量上的心得体会,文章不长,近一百页,叙述恰当,可作参考。 下附目录 前 言 第1 章 文件结构 1.1 版权和版本的声明 1.2 头文件的结构 1.3 定义文件的结构 1.4 头文件的作用 1.5 目录结构 第2 章 程序的版式 2.1 空行 2.2 代码行 2.3 代码行内的空格 2.4 对齐 2.5 长行拆分 2.6 修饰符的位置 2.7 注释 2.8 类的版式 第3 章 命名规则 3.1 共性规则 3.2 简单的WINDOWS 应用程序命名规则 3.3 简单的UNIX 应用程序命名规则 第4 章 表达式和基本语句 4.1 运算符的优先级 4.2 复合表达式 4.3 IF 语句 4.4 循环语句的效率 4.5 FOR 语句的循环控制变量 4.6 SWITCH 语句 4.7 GOTO 语句 第5 章 常量 5.1 为什么需要常量 5.2 CONST 与 #DEFINE 的比较 5.3 常量定义规则 5.4 类中的常量 第6 章 函数设计 6.1 参数的规则 6.2 返回值的规则 6.3 函数内部实现的规则 6.4 其它建议 6.5 使用断言 6.6 引用与指针的比较 第7 章 内存管理 7.1 内存分配方式 7.2 常见的内存错误及其对策 7.3 指针与数组的对比 7.4 指针参数是如何传递内存的? 7.5 FREE 和DELETE 把指针怎么啦? 7.6 动态内存会被自动释放吗? 7.7 杜绝“野指针” 7.8 有了MALLOC/FREE 为什么还要NEW/DELETE ? 7.9 内存耗尽怎么办? 7.10 MALLOC/FREE 的使用要点 7.11 NEW/DELETE 的使用要点 7.12 一些心得体会 第8 章 C++函数的高级特性 8.1 函数重载的概念 8.2 成员函数的重载、覆盖与隐藏 8.3 参数的缺省值 8.4 运算符重载 8.5 函数内联 8.6 一些心得体会 第9 章 类的构造函数、析构函数与赋值函数 9.1 构造函数与析构函数的起源 9.2 构造函数的初始化表 9.3 构造和析构的次序 9.4 示例:类STRING 的构造函数与析构函数 9.5 不要轻视拷贝构造函数与赋值函数 9.6 示例:类STRING 的拷贝构造函数与赋值函数 9.7 偷懒的办法处理拷贝构造函数与赋值函数 9.8 如何在派生类中实现类的基本函数 9.9 一些心得体会 第10 章 类的继承与组合 10.1 继承 10.2 组合 第11 章 其它编程经验 11.1 使用CONST 提高函数的健壮性 11.2 提高程序的效率 11.3 一些有益的建议 参考文献 附录A :C++/C 代码审查表 附录B :C++/C 试题 附录C :C++/C 试题的答案与评分标准

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值