C语言软件编写规范.doc

前言:
一个好的程序编写规范是编写高质量程序的保证。清晰、规范的源程序不仅仅是方便阅读,更重要的是能够便于检查错误,提高调试效率,从而最终保证软件的质量和可维护性。
说明:
本规范适用于公司内使用C语言编码的所有软件。本规范自发布之日起生效,以后新编写的和修改的
代码应遵守本规范。
注:使用固件和操作系统源代码应保留其代码风格
目录
3
4
5

规则1:程序块采用缩进风格编写,每级缩进为4个空格。
程序块采用缩进风格编写,每级缩进为4个空格,不使用TAB键,以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐。
规则2:相对独立的程序块之间、变量说明之后必须加空行。
示例:如下例子不符合规范。
if (!valid_ni(ni))
{
// program code
...
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
// program code
...
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
规则3:一条语句不能过长,如不能拆分需要分行写
换行时有如下建议:
· 换行时要增加一级缩进,使代码可读性更好;
l · 低优先级操作符处划分新行;换行时操作符应该也放下来,放在新
l · 换行时建议一个完整的语句放在一行,不要根据字符数断行
示例:
if ((temp_flag_var == TEST_FLAG)
&&(((temp_counter_var - TEST_COUNT_BEGIN) % TEST_COUNT_MODULE) >= TEST_COUNT_THRESHOLD))
{
// process code
}
规则4: 多个短语句(包括赋值语句)不允许写在同一行内,即一行只写一条语句。
示例:
int a = 5; int b = 10; //不好的排版
较好的排版
int a = 5;
int b = 10;
规则5: if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。
例:
if (value < max)
{
func(value);
}
规则6: 在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后
要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。
(1)比较操作符, 赋值操作符"="、"+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格。
if (current_time >= MAX_TIME_VALUE)
a = b + c;
a *= 2;
a = b ^ 2;
(2)"!"、"