软件编程规范Word文件下载.docx

1、循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。if （taskno max_act_task_number） （n7stat_stat_item_valid （stat_item）for （i = 0, j = 0; （i BufferKeywordword_index.word_length） （j ），后不应加空格。采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧（即左括号后面和右括号前面）不需要加空格，多重括

2、号间不必加空格，因为在C/C+语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。（1） 逗号、分号只在后面加空格。int a, b, c;（2）比较操作符, 赋值操作符=、 +=，算术操作符+、%，逻辑操作符，位域操作符= MAX_TIME_VALUE） a = b + c;a *= 2;a = b 2;（3）!+-（地址运算符）等单目操作符前后不加空格。*p = a; / 内容操作*与内容之间flag = !isEmpty; / 非操作p = &mem; / 地址操作 与内容之间i+; / ,（

3、4）-.前后不加空格。p-id = pid;指针前后不加空格（5） if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。if （a = b & c d）一行程序以小于80字符为宜，不要写得过长。2 注释 2-1：一般情况下，源程序有效注释量必须在20以上。注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志

4、等，头文件的注释中还应有函数功能简要说明。下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/* Copyright （C）, 1988-1999, Huawei Tech. Co., Ltd. File name: / 文件名 Author: Version: Date: / 作者、版本及完成日期 Description: / 用于详细说明此程序文件完成的主要功能，与其他模块 / 或函数的接口，输出值、取值范围、含义及参数间的控 / 制、顺序、独立或依赖等关系 Others: / 其它内容的说明 Function List: / 主要函数列表，每条记录应包括函

5、数名及功能简要说明 1. . History: / 修改历史记录列表，每条修改记录应包括修改日期、修改 / 者及修改内容简述 1. Date:Modification:2. . */ 2-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/* FileName: test.cpp Version : / 模块描述 Version: / 版本信息 / 主要函数及其功能 1. - / 历史修改记录 author version descDavid 96/1

6、0/12 1.0 build this moudle */ Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。2-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。Function: / 函数名称 / 函数功能、性能等的描述 Calls: / 被本函数调用的函数清单 Called By: / 调用本函数的函数清单 Table Accesse

7、d: / 被访问的表（此项仅对于牵扯到数据库操作的程序） Table Updated: / 被修改的表（此项仅对于牵扯到数据库操作的程序） Input: / 输入参数说明，包括每个参数的作 / 用、取值说明及参数间关系。Output: / 对输出参数的说明。Return: / 函数返回值的说明 / 其它说明 2-5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。2-6：注释的内容要清楚、明了，含义准确，防止注释二义性。错误的注释不但无益反而有害。规则2-7：避免在注释中使用缩写，特别是非常用缩写。在使用缩写时或之前，应对缩写进行必要的说明。2-8：

8、注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。例1：/* get replicate sub system index and net indicator */ 例2：应如下书写 2-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。/* active statistic task number */ #define MAX_ACT_TASK_NUMBER 1000 #define MAX_ACT_T

9、ASK_NUMBER 1000 /* active statistic task number */ 2-10：数据结构声明（包括数组、结构、类、枚举等），如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。可按如下形式说明枚举/数据/联合结构。/* sccp interface with sccp user primitive message name */ enum SCCP_USER_PRIMITIVE N_UNITDATA_IND, /* sccp notify sccp user unit data co

10、me */ N_NOTICE_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 Title failure, as follows */ / 变

11、量作用、含义 /* 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：注释与所描述内容进行同样的缩排。可使程序排版整

12、齐，并方便注释的阅读与理解。如下例子，排版不整齐，阅读稍感不方便。void example_fun（ void ） /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two 应改为如下布局。2-13：将注释与其上面的代码用空行隔开。如下例子，显得代码过于紧凑。program code one program code two 2-14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计

13、文档。2-15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。示例（注意斜体加粗部分）：case CMD_UP:ProcessUp（）;break;case CMD_DOWN:ProcessDown（）;case CMD_FWD:ProcessFwd（）;. else ProcessCFW_B（）; / now jump into case CMD_A case CMD_A:ProcessA（）;case CMD_

14、B:ProcessB（）;case CMD_C:ProcessC（）;case CMD_D:ProcessD（）;避免在一行代码或表达式的中间插入注释。除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。在代码的功能、意图层次上进行注释，提供有用、额外的信息。注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。如下注释意义不大。/* if receive_flag is

15、 TRUE */ if （receive_flag） 而如下的注释则给出了额外有用的信息。/* if mtp receive a message from links */ 在程序块的结束行右方加注释标记，以表明某程序块的结束。当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。参见如下例子。/ program code while （index MAX_INDEX） /* end of while （index MAX_INDEX） */ / 指明该条while语句结束 /* end of if （.）*/ / 指明是哪条if语句结束 注释格式尽量统一，建议使用“/* */”

16、。注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。3 标识符命名 3-1：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。如下单词的缩写能够被大家基本认可。temp 可缩写为 tmp ;flag 可缩写为 flg ;statistic 可缩写为 stat ;increment 可缩写为 inc ;me

17、ssage 可缩写为 msg ;3-2：命名中若使用特殊约定或缩写，则要有注释说明。应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。3-3：自己特有的命名风格，要自始至终保持一致，不可来回变化。个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。（即命名规则中没有规定到的地方才可有个人命名风格）。3-4：对于变量命名，禁止取单个字符（如i、j、k.），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如i写成j），而编译时又检查不出来，有可

18、能为了这个小小的错误而花费大量的查错时间。下面所示的局部变量名的定义方法可以借鉴。int liv_Width 其变量名解释如下：l 局部变量（Local） （其它：g 全局变量（Global）.） i 数据类型（Interger） v 变量（Variable） （其它：c 常量（Const）.） Width 变量含义 这样可以防止局部变量与全局变量重名。3-5：命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式，用作特殊标识如标识成员变量或全局变量的m_和g_，其后加上大小写混排的方式是允许的。 Add_User不允许，add_user、AddUser、m_AddUser允许。