19章 编码风格.pptVIP

第19章 编码风格 编码风格不属于技术范畴，但却受到越来越多的重视，随着程序规模的扩大，单单依靠一个人完成所有代码的编写是不可能的，程序员应当培养的是合作和交流的能力，而编码风格决定了程序的可读性，以写文章来比喻，好的风格包括结构清晰，条理，字体工整，这让阅读者十分舒服，也能很快领会文章的意思，而差的风格让人读起来完全摸不着头脑，何来交流可谈。 本章主要从版式，代码风格和项目的组织几个方面探讨一下什么是好的编码风格，重申一遍，这不属于技术范畴，而且没有统一的标准，业界也是辩论不休，本章提出的仅仅是些建议，仅供参考。 19.1 程序的排版 排版这个词好像更多用在文字领域，其实，代码文件也可以看成是部作品，好的程序不仅要做到功能正确，效率高，还要书写规范，便于阅读。 19.1.1 注释 很多读者都有这样的体会，回头看几个月前自己写的代码，完全不知所云，读半天才弄通，相当于重新写了一遍，如果添加了注释，阅读和理解会迅捷很多，注释往往应用于如下场合： 版本、版权声明，文件介绍 函数接口和功能说明 重要的代码行或代码块 注释的位置应与被描述的代码相邻，常放在代码的上方或右方，不推荐放在下方，而且，注释一定要清晰，读了让人更迷糊的注释不如不要，而且，如果对代码进行了修改，注释的修改也要同步进行，否则会让读代码和注释的人摸不着头脑。 19.1.2 空行的用法 编译器不会对空行处理，其仅仅起到分隔段落，区分层次的作用，总体来说，逻辑不相关的代码块间最好都添加一个空行，比如：每个函数定义后，每个类声明后，函数体中的一个if结构后等等。 19.1.3 代码行 根本原则使“一行代码只做一件事情”，不要以为程序中到处是下述形式的代码是件很cool的事情： y=(x++)+(++z); 将其分解为： z++; y=x+z; x++ 更容易阅读，结构更清晰，便于查错排错。 原则上，if、for、while、do之后的执行语句都要加{}，哪怕只有一行，因为以后可能会对if结构修改，始终加上{}有助于防止书写失误。 很多教科书上提倡：尽可能在变量定义的同时初始化，避免遗忘。 19.1.4 空格 代码行之间也需要插入一定数量的空格，使得变量名、关键字和操作符之间有一定的间隙，既方便阅读，又大方美观，如果乱糟糟挤在一起，读起来费劲，想理顺关系也要费点力气。 一般来说，有以下的指导原则： （1）算术运算符（＋—*/等）、比较运算符（ == !=等）、逻辑运算符（ ||）、位操作符（ |）、赋值操作符（＝ +=等），这些二元操作符前后推荐添加空格。 （2）一元操作符，如“!（取反）、~（位反）、++（自增）、--（自减）和（取地址）”前后不加空格。 （3）if、while、for等关键字后推荐留一个空格再接’(’，以突出关键字，但函数名和’(‘之间不加空格，以便区分函数名和关键字。 （4）“( )”内部，’(’后不加空格，’)’前不加空格。 （5）逗号后要加空格，分号如果不是一行的结束（如for结构中的分号），其后应加空格。’[’、’]’、’-’和’.’前后不加空格。 19.1.5 缩进与对齐 以if结构为例，流行两种书写样式： if(condition){ //代码 } 和 if(condition) { //代码 } 其他诸如函数定义、for结构、while结构都存在这两种样式，推荐采用第2种方式，如果出现嵌套的{}，应使用缩进对齐，方便阅读。 19.1.6 和*的位置 以声明指针变量为例，*应靠近类型（int* p;）还是靠近变量名（int *p）一直以来都颇有争议，推荐采用后一种写法，这样，在书写如下代码时： int *p1,p2; 便不会把p2错认为使int型的指针。 19.2 命名规则 如何对变量和函数命名，这对程序来说，不是结果是否正确，效率是否高的决定性因素，程序员完全可以根据自己的喜好创造变量名（也许这是能让程序员感到自己是上帝的地方），如果提出一套条条框框来告诉程序员应如何对变量命名，可能会惹来众多非议，似乎剥夺了程序员控制的权力。 但从另一个角度看，变量名和函数名对程序的阅读很重要，好的命名能让阅读者望文知意，通过几个字母的组合便知道其意义和功能，不用每个都去查厚厚的帮助手册，因此，要写出高质量的代码，需要一套合理的命名规则。 Microsoft公司一直倡导匈牙利命名法，其主要思想是“在函数名或变量之前加上前缀以说明其意义，增进人们的理解”，例如，所有指针都以p开头，所有int型变量都以i开头等等，本节推荐一套成熟有效的命名规则。 19.2.1 Window风格和Unix风格 好的名字应做到短小精悍，短小则输入方便，精悍则望文知意，就书写来说，有两种成熟的风格，Windows风格和Unix风格。 Unix风格的标志是“小写字