|
返回列表 发帖

[新闻共享] 高质量C++/C编程指南学习笔记(上)(转)

高质量C++/C编程指南》是 林锐 博士 写的,现在已经出书了。以下是我在学习中的一些笔记,贴给大家有空看看。

1、  关于版权和版本的声明

版权和版本的声明位于头文件和定义文件的开头。示例如下:

/** Copyright (c) 2001,上海贝尔有限公司网络应用事业部

* All rights reserved.

*

* 文件名称:filename.h

* 文件标识:见配置管理计划书

* 摘    要:简要描述本文件的内容

*

* 当前版本:1.1

* 作    者:输入作者(或修改者)名字

* 完成日期:2001年7月20日

*

* 取代版本:1.0

* 原作者  :输入原作者(或修改者)名字

* 完成日期:2001年5月10日

*/



2、  关于头文件

Ø         为了防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块。

Ø         头文件中只存放“声明”而不存放“定义”,包括内联函数最好也放在定义文件中。

Ø         尽可能少地使用全局变量,尽量不要在头文件中出现象extern int value 这类声明。



3、  源码文件的管理

如果一个软件的头文件数目比较多(如超过十个),通常应将头文件和定义文件分别保存于不同的目录,以便于维护。

例如可将头文件保存于include目录,将定义文件保存于source目录(可以是多级目录)。

如果某些头文件是私有的,它不会被用户的程序直接引用,则没有必要公开其“声明”。为了加强信息隐藏,这些私有的头文件可以和定义文件存放于同一个目录。



4、  空行的作用

在每个类声明之后、每个函数定义结束之后都要加空行。

在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。



5、  代码行

Ø         一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。

Ø         if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。

Ø         尽可能在定义变量的同时初始化该变量



6、  代码行内的空格

这种东西一切都只是为了好看,就象写字一样。字写得差没人会说你,但写的不整齐就不对了。

Ø         函数名之后不要留空格,空格太多会招人烦。

&amp;Oslash;         赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=” “>;=”、“<=”、“+”、“*”、“%”、“&amp;&amp;”、“||”、“<<”,“^”等二元操作符的前后应当加空格。

&amp;Oslash;         一元操作符如“!”、“~”、“++”、“--”、“&amp;”(地址运算符)等前后不加空格。



7、  关于对齐

程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。



8、  长行拆分

代码行最大长度宜控制在70至80个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。



9、  修饰符的位置

应当将修饰符 * 和 & 紧靠变量名



10、注释

&amp;Oslash;         注释是对代码的“提示”,而不是文档。

&amp;Oslash;         对每一个函数模块需注释其实现什么功能,函数的参数说明等。

&amp;Oslash;         注释不要太多,太多了会让人眼花缭乱。

&amp;Oslash;         对本身就很简单的代码句不需要去注释。

&amp;Oslash;         对较复杂的或比较重要的代码段需要对其实现的功能注释。

&amp;Oslash;         边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。

&amp;Oslash;         注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。

&amp;Oslash;         尽量避免在注释中使用缩写,特别是不常用缩写。

&amp;Oslash;         注释的位置应放在代码的上方或右方。

&amp;Oslash;         当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。

&amp;Oslash;         因某些原因而要屏蔽一些代码段时,应在屏蔽代码段的上方注释屏蔽的原因、操作时间和操作人。



11、类的版式

&amp;sup2;        有两种排列方式,一种是以数据为中心,另一种是以行为中心。

&amp;sup2;        建议将Public的函数或变量放在前面,Private的放在最后。



12、命名规则

&amp;sup2;        标识符应当直观且可以拼读,可望文知意,不必进行“解码”。

&amp;sup2;        标识符的长度应当符合“min-length &amp;&amp; max-information”原则。

&amp;sup2;        单字符的名字也是有用的,常见的如i,j,k,m,n,x,y,z等,它们通常可用作函数内的局部变量。

&amp;sup2;        在Windows应用程序的标识符中通常采用“大小写”混排的方式,如AddChild。

&amp;sup2;        程序中不要出现仅靠大小写区分的相似的标识符。

&amp;sup2;        局部变量名最好不要和全局变量名相同

&amp;sup2;        变量的名字应当使用“名词”或者“形容词+名词”。

&amp;sup2;        全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。类的成员函数应当只使用“动词”,被省略掉的名词就是对象本身。

&amp;sup2;        用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

&amp;sup2;        尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。

&amp;sup2;        类名和函数名用大写字母开头的单词组合而成。

&amp;sup2;        变量和参数用小写字母开头的单词组合而成。

&amp;sup2;        常量全用大写的字母,用下划线分割单词。

&amp;sup2;        静态变量加前缀s_(表示static)。

&amp;sup2;        如果不得已需要全局变量,则使全局变量加前缀g_(表示global)。

&amp;sup2;        类的数据成员加前缀m_(表示member),这样可以避免数据成员与成员函数的参数同名。

&amp;sup2;        为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头,所有常量(或宏定义)均以GL开头。



13、表达式和基本语句

&amp;sup2;        如果代码行中的运算符比较多,用括号确定表达式的操作顺序,避免使用默认的优先级。

&amp;sup2;        不要编写太复杂的复合表达式。

&amp;sup2;        不要有多用途的复合表达式。

&amp;sup2;        不要把程序中的复合表达式与“真正的数学表达式”混淆。

&amp;sup2;        不可将布尔变量直接与TRUE、FALSE或者1、0进行比较。

&amp;sup2;        应当将整型变量用“==”或“!=”直接与0比较

&amp;sup2;        不可将浮点变量用“==”或“!=”与任何数字比较。

&amp;sup2;        应当将指针变量用“==”或“!=”与NULL比较。

&amp;sup2;        在多重循环中,如果有可能,应当将循环次数最多的循环放在最内层,最少的循环放在最外层,以减少CPU跨切循环层的次数。

&amp;sup2;        不可在for 循环体内修改循环变量,防止for 循环失去控制。

&amp;sup2;        建议for语句的循环控制变量的取值采用“半开半闭区间”写法。

&amp;sup2;        每个case语句的结尾不要忘了加break,否则将导致多个分支重叠(除非有意使多个分支重叠)。

&amp;sup2;        不要忘记最后那个default分支。即使程序真的不需要default处理,也应该保留语句   default : break; 这样做并非多此一举,而是为了防止别人误以为你忘了default处理。

&amp;sup2;        尽可能少地使用goto语句,但不是禁用。
分享至

很全面很专业

TOP

楼主辛苦了

TOP

值得借鉴

TOP

分析的很透彻

TOP

分析的很好

TOP

长知识了

TOP

淘宝不让卖的,谷谷交易平台可以卖,淘宝买不到的,谷谷交易可以买到。

TOP

返回列表

管理员推荐 关闭


看DELL微视频,就有机会赢大奖

观看戴尔微视频并截图,在活动贴中回复你的邮箱+点评就有机会赢大奖!还等什么,快来参加吧!


查看