常见代码编写规范:
1、为了防止头文件被重复引用,应当用ifndef/define/endif 结构产生预 处理块。
2、用 #include <filename.h> 格式来引用标准库的头文件(编译器将 从标准库目录开始搜索)。
5、在每个类声明之后、每个函数定义结束之后都要加空行。
6、在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。
例:
7、一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。
8、if、for、while、do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
9、 建议在定义变量的同时初始化该变量(就近原则) 如果变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。如果引用 了未被初始化的变量,可能会导致程序错误。本建议可以减少隐患。
10、关键字之后要留空格。象 const、virtual、inline、case 等关键字之 后至少要留一个空格,否则无法辨析关键字。象 if、for、while 等关键字之后应留 一个空格再跟左括号‘(’,以突出关键字。
11、函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。
12、‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。
13、‘,’之后要留空格,如 Function(x, y, z)。如果‘;’不是一行的结束符号,其后要留空格,如 for (initialization; condition; update)。
14、赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符, 如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二 元操作符的前后应当加空格。
15、一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格。
16、象“[]”、“.”、“->”这类操作符前后不加空格。
17、代码行最大长度宜控制在 70 至 80 个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。
18、长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以 便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。
例:长行的拆分
注:修饰符 * 和 & 应该靠近数据类型还是该靠近变量名,是个有争议的活题。若将修饰符 * 靠近数据类型,例如:int* x; 从语义上讲此写法比较直观,即 x是 int 类型的指针。上述写法的弊端是容易引起误解,例如:int* x, y; 此处 y 容易被误解为指针变量。虽然将 x 和 y 分行定义可以避免误解,但并不是人人都愿意这样做。
![](https://i-blog.csdnimg.cn/blog_migrate/17ec0bee0d3f0cf1c175cbdd6eb9df5b.png)