C编码规范.pptVIP

第15章 C++编码规范 本章讲述的时候,可以利用Word文档来讲,该章Word文档提供 内容提要 目前，计算机教育基本没有灌输高质量程序设计的观念，也很少自觉关心程序设计的规范性问题。 本章主要介绍C++编码规范，主要从4个方面来探讨：程序文件结构、命名规则与可读性、单元代码的规范性以及程序的效率。全章内容部分参考了国内几大软件公司的编码规范。 C++文件的程序结构 编程序可以跟着自己的思路编写，但是阅读别人的程序需要先理顺程序的思路。 代码的排版以及注释将直接影响修改以及测试程序的效率。 程序的排版 （1）程序块要采用缩进风格编写，缩进的空格数为4个。说明：对于由开发工具自动生成的代码可以有不一致。 （2）相对独立的程序块之间、变量说明之后必须加空行。如下例子不符合规范。 if (!valid_ni(ni)) { ... // program code } repssn_ind = ssn_data[index].repssn_index; 应如下书写： if (!valid_ni(ni)) { ... // program code } ? repssn_ind = ssn_data[index].repssn_index; 程序的排版 （3）较长的语句（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 （4）循环和判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。 （5）不允许把多个短语句写在一行中，即一行只写一条语句。如下例子不符合规范。 程序的排版 6）if、for、do、while、case、switch和default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。 （7）程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。 （8）在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－）后不应加空格。 注释 一般情况下，源程序有效注释量必须在20％以上。注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。包括11个方面。 （1）说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。 注释 （2）源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 （3）函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。 注释 （4）边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性，不再有用的注释要删除。尽量避免在注释中使用缩写，特别是常用缩写。如果使用，在使用缩写时或之前，应对缩写进行必要的说明。 （5）注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。 命名规则与可读性 程序中变量、常量、标识符、函数以及类名，在实际工程编码的时候，需要遵循一定的规范。 一般不同的软件公司，命名规范可能会有所区别，但是总体上来说，都大同小异。总之，在编写代码的时候，命名规则都应该和项目组其他成员保持一致。 标识符命名 （1）标识符的命名要清晰明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。 （2）自己特有的命名风格，要自始至终保持一致，不可来回变化。个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。即命名规则中没有规定到的地方才可有个人命名风格。 标识符命名 （3）对于变量命名，禁止取单个字符（如i、j、k...），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。 （4）命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式，用作特殊标识如标识成员变量或全局变量的m_和g_，其后