《软件编程技术规范》由会员分享，可在线阅读，更多相关《软件编程技术规范（59页珍藏版）》请在金锄头文库上搜索。
1、目目 录录1 排版6 2 注释11 3 标识符命名18 4 可读性20 5 变量、结构22 6 函数、过程28 7 可测性36 8 程序效率40 9 质量保证44 10 代码编辑、编译、审查50 11 代码测试、维护52 12 宏53软件编程规范总则1 排版仅供内部使用21 排版排版1-1：程序块要采用缩进风格编写，缩进的空格数为：程序块要采用缩进风格编写，缩进的空格数为4个。个。说明：对于由开发工具自动生成的代码可以有不一致。1-2：相对独立的程序块之间、变量说明之后必须加空行。：相对独立的程序块之间、变量说明之后必须加空行。示例：如下例子不符合规范。if (!valid_ni(ni). /
2、 program coderepssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;应如下书写if (!valid_ni(ni). / program coderepssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;1-3：较长的语句（：较长的语句（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语
3、句可读。操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN+ STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_tableframe_id * STAT_TASK_CHECK_NUMBER + index.occupied= stat_poiindex.occupied;act_task_tabletaskno.duration_true_or_false= SYS_get_sccp_statistic_state( stat
4、_item );report_or_not_flag = (taskno ），后不应加空），后不应加空格。格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在 C/C+语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。示例：(1) 逗号、分号只在后面加空格。int a, b, c; 软件编程规范总则1 排版仅供内部使
5、用7(2)比较操作符, 赋值操作符“=“、 “+=“，算术操作符“+“、“%“，逻辑操作符“a *= 2;a = b 2;(3)“!“、“、“+“、“-“、“ / 内容操作“*“与内容之间flag = !isEmpty; / 非操作“!“与内容之间p = / 地址操作“ / “+“,“-“与内容之间(4)“-“、“.“前后不加空格。p-id = pid; / “-“指针前后不加空格(5) if、for、while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出、明显。if (a = b repssn_ni = ssn_dataindex.ni;例 2：repssn_ind
6、= ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;/* get replicate sub system index and net indicator */应如下书写/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;2-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加：对于所有有物理含义的变量、常量，如
7、果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。示例：/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000软件编程规范总则2 注释仅供内部使用11#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */2-10：数据结构声明：数据结构声明(包括数组、结构、类、枚举等包括数组、结构、类、枚举等)，如果其命
8、名不是充分自注释的，必须，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。释放在此域的右方。示例：可按如下形式说明枚举/数据/联合结构。/* sccp interface with sccp user primitive message name */enum SCCP_USER_PRIMITIVEN_UNITDATA_IND, /* sccp notify sccp user unit data come */N_NOTICE_
9、IND, /* sccp notify user the No.7 network can not */* transmission this message */N_UNITDATA_REQ, /* sccp users unit data transmission request*/;2-11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。存取时注意事项等的说明。示例：/* The ErrorCode when SCCP translate */* Global
10、Title failure, as follows */ / 变量作用、含义/* 0 SUCCESS 1 GT Table error */* 2 GT error Others no use */ / 变量取值范围/* only function SCCPTranslate() in */* this modual can modify it, and other */* module can visit it through call */* the function GetGTTransErrorCode() */ / 使用方法BYTE g_GTTranErrorCode; 2-12：注
11、释与所描述内容进行同样的缩排。：注释与所描述内容进行同样的缩排。说明：可使程序排版整齐，并方便注释的阅读与理解。示例：如下例子，排版不整齐，阅读稍感不方便。void example_fun( void )软件编程规范总则2 注释仅供内部使用12/* code one comments */CodeBlock One/* code two comments */CodeBlock Two应改为如下布局。void example_fun( void )/* code one comments */CodeBlock One/* code two comments */CodeBlock Two2-
12、13：将注释与其上面的代码用空行隔开。：将注释与其上面的代码用空行隔开。示例：如下例子，显得代码过于紧凑。/* code one comments */program code one/* code two comments */program code two应如下书写/* code one comments */program code one/* code two comments */program code two2-14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。说明：这些语句往往是程序实现某一特定功能
13、的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。软件编程规范总则2 注释仅供内部使用132-15：对于：对于switch语句下的语句下的case语句，如果因为特殊情况需要处理完一个语句，如果因为特殊情况需要处理完一个case后进入下一后进入下一个个case处理，必须在该处理，必须在该case语句处理完、下一个语句处理完、下一个case语句前加上明确的注释。语句前加上明确的注释。说明：这样比较清楚程序编写者的意图，有效防止无故遗漏 break 语句。示例（注意斜体加粗部分）：case CMD_UP: ProcessUp(); break;case CMD_DOWN
14、: ProcessDown(); break;case CMD_FWD: ProcessFwd(); if (.).break;elseProcessCFW_B(); / now jump into case CMD_Acase CMD_A: ProcessA(); break;case CMD_B: ProcessB(); break;case CMD_C: ProcessC(); 软件编程规范总则2 注释仅供内部使用14break;case CMD_D: ProcessD(); break;.2-1：避免在一行代码或表达式的中间插入注释。：避免在一行代码或表达式的中间插入注释。说明：除非必
15、要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。2-2：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。为自注释的。说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。2-3：在代码的功能、意图层次上进行注释，提供有用、额外的信息。：在代码的功能、意图层次上进行注释，提供有用、额外的信息。说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。示例：如下注释意义不大。/* if receive_flag is TRUE */if (receive_flag)而如下的注释则给出了额外有用的信息。 /* if mtp receive a message from links */if (receive_flag)2-4：在程序块的结束行右方加注释标记，以表明某程序块的结束。：在程序块的结束行右方加注释标记，以表明某程序块的结束。说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。示例：参见如下例子。if (.)/ program codewhile (index b ) ? a : b ;改为如下就很清晰了。int max (int a, int b)re
