文档介绍：内部资料
注意保密
软件编程规范
文档编号:
密级:
版本信息:
建立日期:2007-09-17
创建人:夏哲星
审核者:
批准人:
批准日期:
文档修订记录
版本编号或者更改记录编号
*变化
状态
简要说明(变更内容和变更范围)
日期
变更人
批准日期
批准人
A
2007-9-17
夏哲星
M
2007-10-15
夏哲星
M
再次讨论后修改
2008-5-15
陈华林
*变化状态:A——增加,M——修改,D——删除
目录
前言 1
第 1 章排版 2
第 2 章注释 5
第 3 章命名规则 8
第 4 章表达式和基本语句 10
第 5 章变量、结构 15
第 6 章函数、过程 21
第 7 章内存管理 25
第 8 章宏 26
第 9 章可测性 27
前言
为了提高源程序的质量和可维护性,最终提高公司软件产品生产力,对公司软件产品的源程序的编写风格作出统一的规范约束。
本规范是独立于具体语言的编程规则的总的原则,针对不同编程语言或应用环境的编程规范在遵守本规范总则的基础上,还必须遵守相应语言和就用环境的编程规范。
本规范的内容包括:排版、注释、命名规则、变量使用、代码可测性等。
本规范的示例都以C语言为背景,采用以下的术语描述:
★规则:编程时强制必须遵守的原则。
★建议:编程时必须加以考虑的原则。
★说明:对此规则或建议进行必要的解释。
★示例:对此规则或建议给出例子。
第 1 章排版
[建议]:采用缩进风格编写,缩进的空格数为4个。
[说明]:缩进使用空格键,不使用TAB键。避免使用不同编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐。
在函数或过程的开始、结构的定义及循环、判断等语句中的代码要采用缩进风格。
case语句也要遵从语句缩进要求。
[建议]:相对独立的程序块间、变量说明之后必须加空行。
[建议]:较长的语句要分成多行书写。
[说明]:长语句要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进。使排版整齐,语句可读。
[示例]:
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied
= stat_poi[index].occupied;
report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)
&& (n7stat_stat_item_valid (stat_item))
&& (act_task_table[taskno].result_data != 0));
if ((taskno < max_act_task_number)
&& (n7stat_stat_item_valid (stat_item)))
{
... // program code
}
for (i = 0, j = 0;
(i < first_word_length) && (j < second_word_length);
i++, j++)
{
... // program code
}
pare((BYTE *) & stat_object,
(BYTE *) & (act_task_table[taskno].stat_object),
sizeof (_STAT_OBJECT));
[建议]:不允许把多个短语句写在一行中,即一行只允许写一条语句。
[示例]:如下例子不符合规范。
= 0; = 0;
应如下书写
= 0;
= 0;
[规则]:if、for、do、while、case、switch、default等语句独自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。
[示例]:如下例子不符合规范。
if (pUserCR == NULL) return;
应如下书写:
if (pUserCR == NULL)
{
return;
}
[规则]:同一文件中{}的风格应该保持一致。
[建议]:程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句