c/c++培训之漫谈软件编码风格

漫谈软件编码风格
  
    通过建立代码编写规范，形成开发小组编码约定，提高程序的可靠性、可读性、可修改性、可维护性、一致性，保证程序代码的质量，继承软件开发成果，充分利用资源。提高程序的可继承性，使开发人员之间的工作成果可以共享。代码的风格主要有以下几点：
1、缩进
缩进以4个空格为单位。预处理语句、全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。语句块的“{”“}”配对对齐，并与其前一行对齐，语句块类的语句缩进建议每个“{”“}”单独占一行。
2、空格
变量、类、常量数据和函数在其类型，修饰（如 __fastcall 等）名称之间适当空格并据情况对齐。关键字原则上空一格，如： if ( ... ) 等，运算符的空格规定如下：“::”、“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”（指正负号）， “&”（取址或引用）、“*”（指使用指针时）等几个运算符两边不加空格（其中单目运算符系指与操作数相连的一边），其它运算符（包括大多数二目运算符和三目运算符“?:”两边均加一空格，“(”、“)”运算符在其内侧空一格，在作函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。“,”运算符只在其后空一格，需对齐时也可不空或多空格，“sizeof”运算符建议也在其后空一格，不论是否有括号，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。
3、对齐
原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在“,”处或运算符处，换行后最好以运算符打头，并且以下各行均以该语句首行缩进，但该语句仍以首行的缩进为准，即如其下一行为“{”应与首行对齐。
变量定义最好通过添加空格形成对齐，同一类型的变量最好放在一起。
4、空行
程序文件结构各部分之间空两行，若不必要也可只空一行，各函数实现之间一般空两行，由于BCB会自动产生一行“//------”做分隔，另因每个函数还要有函数说明注释，故通常只需空一行或不空，但对于没有函数说明的情况至少应再空一行。对自己写的函数，建议也加上“//------”做分隔。函数内部数据与代码之间应空至少一行，代码中适当处应以空行空开，建议在代码中出现变量声明时，在其前空一行。类中四个“p”之间至少空一行，在其中的数据与函数之间也应空行。
5、注释
对注释有以下三点要求：
A.必须是有意义。
B.必须正确的描述了程序。
C.必须是最新的。
注释必不可少，但也不应过多，以下是四种必要的注释：
A.标题、附加说明。
B.函数说明。对几乎每个函数都应有适当的说明，通常加在函数实现之前，在没有函数实现部分的情况下则加在函数原型前，其内容主要是函数的功能、目的、算法等说明，参数说明、返回值说明等，必要时还要有一些如特别的软硬件要求等说明。
C.在代码不明晰或不可移植处必须有一定的说明。
D.及少量的其它注释。
注释有块注释和行注释两种，分别是指：“/**/”和“//”建议对A用块注释，D用行注释，B、C则视情况而定，但应统一，至少在一个单元中B类注释形式应统一。
6、代码长度：
对于每一个函数建议尽可能控制其代码长度为53行左右，超过53行的代码要重新考虑将其拆分为两个或两个以上的函数。函数拆分规则应该一不破坏原有算法为基础，同时拆分出来的部分应该是可以重复利用的。对于在多个模块或者窗体中都要用到的重复性代码，完全可以将起独立成为一个具备公用性质的函数，放置于一个公用模块中(Common.cpp/Common.h)。
 
 本文版权归传智播客C++培训学院所有，欢迎转载，转载请注明作者出处。谢谢！
作者：传智播客C/C++培训学院
首发：http://www.itcast.cn/c/