文档介绍：XX产品研究部
文档编号
产品版本
密级
开发适用
共页
收文:XX产品研究部软件开发人员
软件开发代码规范
(仅供内部使用)
拟制:
周超
日期:
2011-5-11
审核:
日期:
核准:
日期:
签发:
日期:
文档版本:
目录
第一章原则 5
第二章排版 6
空行 6
代码行 7
代码行内的空格 7
对齐缩进 8
长行拆分 9
第三章注释 11
通用规则 11
文件注释 11
函数注释 12
数据注释 13
代码注释 13
第四章命名 16
通用命名规则 16
文件命名 16
类型命名 16
变量命名 17
常量命名 18
函数命名 18
枚举命名 18
宏命名 18
第五章杂项 20
文件修改记录
修改日期
版本
修改页码、章节、条款
修改描述
作者
2011-4-29
创建初稿
周超
2011-5-11
1)【规则3-4-3】全局变量注释例子
2)在“”、“”、“”中,增加对前缀、关键缩写词等可以适当全部大写的处理。
周超
第一章原则
本文档的目的是提供一个公共的编码规范。
这个规范详细阐述在编码时要怎样写、不要怎样写,旨在提高代码的可读性、可维护性,使代码易于管理,使所有人可以集中精力去实现内容,而非处理各种复杂的表现形式。
使代码易于管理的方法之一是增强代码一致性,让别人可以读懂你的代码是很重要的,保持统一编程风格意味着可以轻松根据“模式匹配”规则推断各种符号的含义。创建通用的、必需的习惯用语和模式可以使代码更加容易理解。虽然在某些情况下改变一些编程风格可能会是好的选择,但我们还是应该遵循一致性原则,尽量不这样去做。
关键在于保持一致。
第二章排版
空行
【规则2-1-1】在每个函数、结构体、枚举定义结束之后都要加空行。
【规则2-1-2】在一个函数体内,逻辑密切相关的语句之间不加空行,其它地方应加空行分隔。
struct st1
{
…
};
// 空行
enum
{
…
};
// 空行
void Function1(…)
{
…
}
// 空行
void Function2(…)
{
…
}
// 空行
while (condition)
{
statement1;
// 空行
if (condition)
{
statement2;
}
else
{
statement3;
}
// 空行
statement4;
}
函数之间的空行函数内部的空行
【规则2-1-3】相对独立的程序块之间、变量说明之后必须加空行。
if (!)
{
... // program code
}
GetLockPhoneInfo(&st_lock_phone_info);
if (!)
{
... // program code
}
//空格
GetLockPhoneInfo(&st_lock_phone_info);
不规范代码规范代码
代码行
【规则2-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。
【规则2-2-2】if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
int width, height, depth;// 宽度高度深度
int width; // 宽度
int height; // 高度
int 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();
}
// 空行
other();