《高质量C++/C编程指南》代码规范笔记

本文档摘录自林锐博士的《高质量C++/C编程指南》,详细介绍了编程规范中的程序版式、命名规则等内容,包括代码布局、变量命名等具体实践建议。

今天查看了一下编程规范,无意中搜索到林锐博士的 《高质量C++/C编程指南》,这对编程挺有帮助的,特意做了一下笔记

第2章 程序的版式


2.1空行

2-1-1 在每个类和函数结束之后加空行

2-2-1 在函数体内,逻辑密切语句不加,其它地方加空行分隔 

2-2-1 一行代码只定义一个变量或一条语句

2-2-2 if 、for、while、do等语句自占一行,执行语句不得紧跟,后面都要有{}

2-2-3 尽可能定义变量就同时初始化 如: int width = 10;


2.3 代码内的空格

2-3-1 关键字后留空格,如case 、const,像if、for、while等关键字之后留一个空格再跟左括号“(”,突出关键字

2-3-1函数名之后不留空格,紧跟左括号“(”,与关键字区别

2-3-3“(”向后紧跟  “)”、“,”、“;”像前紧跟,紧跟处不留空格

2-3-4“,”之后要留空格,如Fun(x, y, z).如果“;”不是一行的结束符号,其后要留空格,如for(int i; i<10; i++)

2-3-5  赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=、+=、>=、+、*等二元操作符的前后应当加空格

2-3-6 一元操作符如!~ ++ -- &()地址运算符)等前后不加空格

2-3-7像 [ ] . ->等这类操作符前后不加空格


2、5长行拆分

2-5-1代码最长控制在70-80字符内


2、6修饰符的位置

2-6-1应当将修饰符*和&紧靠变量名

如: char *name  ;

       int  *x, y;


2、7类的版式

2-7-1建议以行为为中心,即为public类型的函数写在前面,private的类型数据写在后面


第3章 命名规则

3.1共性规则

3-1-3命名规则尽量与所采用的操作系统风格一致,如windows的AddChild和 Unix的add_child保持一致,不要混用

3-1-4程序不要出现大小写区分的标识符

3-1-5不要出现标识符一致的局部和全局变量

3-1-6变量最好位形容词+名词

3-1-7全局函数的名字使用动词或者动词+名词,类的成员函数只使用动词

3-1-8避免出现数字编号,如valude1、value2等,除非逻辑需要


第四章 表达式和基本语句

4-1-1如果代码行中的运算符比较多,使用括号确定表达式的顺序


第6章 函数设计

6-1-1参数的书写要完整

void Fun(int a, int b); //良好的风格

void Fun(int , int ); //不良

float Fun(void);  //良好的风格

float Fun();// 不良

6-1-2参数的命名要合理,如不要出现char *str1和char *str2

6-1-3如果参数时指针,且仅为输入的作用,则应在类型加const ,防止该指针在函数内被修改

6-1-4如果输入参数以值传递的方式传递对象,则应该用const& 方式来传递,这样可以省去临时对象的构造和析构的过程

6-1-5避免参数太多


6.2返回值的规则

6-2-1不要省略返回值的类型

6-2-2函数名字的返回值类型在语义上不可冲突

待续。。。。。





目 录 前 言6 第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 章 函数设计 高质量C++/C 编程指南,v 1.0 2001 Page 4 of 101 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 章 类的继承组合. 高质量C++/C 编程指南,v 1.0 2001 Page 5 of 101 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、付费专栏及课程。

余额充值