1、仅供内部使用 1软件开发规范1 排版 1-1：程序块要采用缩进风格编写，缩进的空格数为4个。说明：对于由开发工具自动生成的代码可以有不一致。 1-2：相对独立的程序块之间、变量说明之后必须加空行。示例：如下例子不符合规范。if (!valid_ni(ni). / 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
2、 = ssn_dataindex.ni; 1-3：较长的语句（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN+ STAT_SIZE_PER_FRAM * sizeof( _UL );仅供内部使用 2act_task_tableframe_id * STAT_TASK_CHECK_NUMBER + index.occupied= stat_poiindex.occupied;act_task_tab
3、letaskno.duration_true_or_false= SYS_get_sccp_statistic_state( stat_item );report_or_not_flag = (taskno ），后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在 C/C+语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续
4、留两个以上空格。示例：(1) 逗号、分号只在后面加空格。int a, b, c; (2)比较操作符, 赋值操作符 “=“、 “+=“，算术操作符“+“、“%“，逻辑操作符仅供内部使用 6“a *= 2;a = b 2;(3)“!“、“、“+“、“-“、“ / 内容操作“*“与内容之间flag = !isEmpty; / 非操作“!“与内容之间p = / 地址操作“ / “+“,“-“与内容之间(4)“-“、“.“ 前后不加空格。p-id = pid; / “-“指针前后不加空格(5) if、for、while、switch 等与后面的括号间应加空格 ，使 if 等关键字更为突出、明显。if (
5、a = b repssn_ni = ssn_dataindex.ni;例 2：repssn_ind = 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：对于所有有
6、物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。仅供内部使用 10示例：/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */ 2-10：数据结构声明 (包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注
7、释放在此域的右方。示例：可按如下形式说明枚举/数据/ 联合结构。/* sccp interface with sccp user primitive message name */enum SCCP_USER_PRIMITIVEN_UNITDATA_IND, /* sccp notify sccp user unit data come */N_NOTICE_IND, /* sccp notify user the No.7 network can not */* transmission this message */N_UNITDATA_REQ, /* sccp users unit da
8、ta transmission request*/; 2-11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。示例：/* The ErrorCode when SCCP translate */* Global Title failure, as follows */ / 变量作用、含义/* 0 SUCCESS 1 GT Table error */* 2 GT error Others no use */ / 变量取值范围/* only function SCCPTranslate() in */* this modual can modi
9、fy it, and other */* module can visit it through call */* the function GetGTTransErrorCode() */ / 使用方法BYTE g_GTTranErrorCode; 2-12：注释与所描述内容进行同样的缩排。仅供内部使用 11说明：可使程序排版整齐，并方便注释的阅读与理解。示例：如下例子，排版不整齐，阅读稍感不方便。void example_fun( void )/* code one comments */CodeBlock One/* code two comments */CodeBlock Two应改
10、为如下布局。void example_fun( void )/* code one comments */CodeBlock One/* code two comments */CodeBlock Two 2-13：将注释与其上面的代码用空行隔开。示例：如下例子，显得代码过于紧凑。/* code one comments */program code one/* code two comments */program code two应如下书写/* code one comments */program code one/* code two comments */program code t
11、wo 2-14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。仅供内部使用 12说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。 2-15：对于 switch语句下的 case语句，如果因为特殊情况需要处理完一个case后进入下一个case 处理，必须在该case 语句处理完、下一个case语句前加上明确的注释。说明：这样比较清楚程序编写者的意图，有效防止无故遗漏 break 语句。示例（注意斜体加粗部分）：case CMD_UP: ProcessUp(); break;case CMD_DOWN: Proc
12、essDown(); break;case CMD_FWD: ProcessFwd(); if (.).break;elseProcessCFW_B(); / now jump into case CMD_Acase CMD_A: ProcessA(); break;case CMD_B: ProcessB(); break;仅供内部使用 13case CMD_C: ProcessC(); break;case CMD_D: ProcessD(); break;. 2-1：避免在一行代码或表达式的中间插入注释。说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。 2-2：
13、通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。 2-3：在代码的功能、意图层次上进行注释，提供有用、额外的信息。说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。示例：如下注释意义不大。/* if receive_flag is TRUE */if (receive_flag)而如下的注释则给出了额外有用的信息。 /* if mtp receive a message from links */if (receive
14、_flag) 2-4：在程序块的结束行右方加注释标记，以表明某程序块的结束。说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。示例：参见如下例子。if (.)/ program codewhile (index b ) ? a : b ;改为如下就很清晰了。int max (int a, int b)return (a b) ? a : b);value = max (a, b);或改为如下。#define MAX (a, b) (a) (b) ? (a) : (b)仅供内部使用 30value = MAX (a, b); 6-5：不要设计多用途面面俱到的函数。说明：多
15、功能集于一身的函数，很可能使函数的理解、测试、维护等变得困难。 6-6：函数的功能应该是可以预测的，也就是只要输入数据相同就应产生同样的输出。说明：带有内部“存储器”的函数的功能可能是不可预测的，因为它的输出可能取决于内部存储器（如某标记）的状态。这样的函数既不易于理解又不利于测试和维护。在C/C+语言中，函数的 static 局部变量是函数的内部存储器，有可能使函数的功能不可预测，然而，当某函数的返回值为指针类型时，则必须是 STATIC 的局部变量的地址作为返回值，若为 AUTO 类，则返回为错针。示例：如下函数，其返回值（即功能）是不可预测的。unsigned int integer_s
16、um( unsigned int base )unsigned int index;static unsigned int sum = 0; / 注意，是 static 类型的。/ 若改为 auto 类型，则函数即变为可预测。for (index = 1; index = base; index+)sum += index;return sum; 6-7：尽量不要编写依赖于其他函数内部实现的函数。说明：此条为函数独立性的基本要求。由于目前大部分高级语言都是结构化的，所以通过具体语言的语法要求与编译器功能，基本就可以防止这种情况发生。但在汇编语言中，由于其灵活性，很可能使函数出现这种情况。示例：如下是在 DOS 下 TASM 的汇编程序例子。过程 Print_Msg 的实现依赖于Input_Msg 的具体实现，这种程序是非结构化的，难以维护、修改。. / 程序代码proc Print_Msg / 过程（函数）Print_Msg. / 程序代码
