文档介绍：C++编码规范
Version:
ode:
Date: 2013-5-29
重要声明
版权声明
本文档中的任何内容受《中华人民共和国著作权法》的保护,版权所有© 2015, 展讯通信有限公司,保留所有权利,但注明引用其他方的内容除外。
商标声明
展讯通信有限公司和展讯通信有限公司的产品是展讯通信有限公司专有。在提及其他公司及其产品时将使用各自公司所拥有的商标,这种使用的目的仅限于引用。
不作保证声明
展讯通信有限公司不对此文档中的任何内容作任何明示或暗示的陈述或保证,而且不对特定目的的适销性及适用性或者任何间接、特殊或连带的损失承担任何责任。
保密声明
本文档(包括任何附件)包含的信息是保密信息。接收人了解其获得的本文档是保密的,除用于规定的目的外不得用于任何目的,也不得将本文档泄露给任何第三方。
目录
目录 3
一、 简介 4
二、 程序版式 5
空行 5
代码行 6
修饰符的位置 8
代码行内的空格 9
对齐 10
注释 12
类的版式 14
三、 命名规则 16
共性规则 16
宏 18
标识符 18
四、 函数规范 19
参数规则 19
返回值规则 20
函数体 20
五、 界面规范 21
对话框 21
控件 22
主命令按钮 23
规范性 25
六、 公用库 26
七、 其它 27
语言 27
通用规则 27
通用规范 28
类的范例 30
八、 团队合作 32
附录A:Revision History 33
简介
该文档列举了一些基本的编程技能并提供了一些好的编程****惯。其主要作用是增强程序的可读性和可维护性。
保证一个开发小组产生高质量的代码的最容易的方式就是建立一个编程规范,并通过日常的代码检视保证其被严格遵守。
一个全面的编程规范应该覆盖构成代码的所有部分,这样所有开发者就可以在他的实现中严格遵守。所有的代码就会具有一致的风格,如同出自一个开发者之手。
虽然代码检视的主要作用是在整个开发生命周期中来发现代码中存在的缺陷,但其也可以用来保证编程规范的贯彻。
说明:该文档中类似于“【】”加灰显示的章节,为编程建议,不做强制要求。
程序版式
空行
【】在每个类声明之后、每个函数定义结束之后都要加空行。
【】在一个函数体内,逻辑上密切相关的语句之间不加空行,其它地方应加空行分隔。
【】加空行时,一般不同时出现两个连续空行。
 
函数之间的空行
函数内部的空行
// 空行
void Function1(…)
{
…
}
// 空行
void Function2(…)
{
…
}
// 空行
void Function3(…)
{
…
}
// 空行
while (condition)
{
statement1;
// 空行
if (condition)
{
statement2;
}
else
{
statement3;
}
// 空行
statement4;
dosomething();
// 空行
return true;
}
代码行
【】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。
【】 if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
 
良好的风格
不良的风格
int width;      // 宽度
int height;     // 高度
int depth;      // 深度
int width, height, depth; // 宽度高度深度
x = a + b;
y = c + d;
z = e + f;
X = a + b;   y = c + d;  z = e + f;
if (width < height)
{
dosomething();
}
if (width < height) dosomething();
for (initialization; condition; update)
{
dosomething();
}
// 空行
other();
for (initialization; condition; update)
dosomething(