高质量C/C++编码规范

1.为了防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块。
2.用#include <filename.h> 格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。
3.用#include “filename.h” 格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)
4.头文件中只存放“声明”而不存放“定义”
5.不提倡使用全局变量,尽量不要在头文件中出现象extern int value 这类声明
6.在每个类声明之后、每个函数定义结束之后都要加空行。
7.在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。
8.一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。
9.if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
10.尽可能在定义变量的同时初始化该变量(就近原则)
11.关键字之后要留空格。象const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。
12.函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。
13.‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。
14.‘,’之后要留空格,如Function(x, y, z)。如果‘;’不是一行的结束符号,其后要留空格,如for (initialization; condition; update)。
15.赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。
16.一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格。
17.象“[]”、“.”、“->”这类操作符前后不加空格。
18.对于表达式比较长的for语句和if语句,为了紧凑起见可以适当地去掉一些空格,如for (i=0; i<10; i++)和if ((a<=b) && (c<=d))
19.程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。
20.{ }之内的代码块在‘{’右边数格处左对齐。
21.代码行最大长度宜控制在70至80个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。
22.长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。
23.应当将修饰符 * 和&紧靠变量名
24.注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。注释的花样要少。
25.如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。例如
i++;     // i 加 1,多余的注释
26.注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。

27.边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
28.尽量避免在注释中使用缩写,特别是不常用缩写。
29.注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方。
30.当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值