软件编程标准和范例.docx

1、软件编程标准和范例软件编程标准和范例 作者： 日期： 1.排版1.1.公共部分1-1：程序块要采用缩进风格编写，缩进为Tab(设定为4个字符)或者4个空格。同一个项目必须保持一致.说明：对于由开发工具自动生成的代码可以有不一致。1-2：较长的语句（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof(_UL);act_task_tablefra

2、me_id * STAT_TASK_CHECK_NUMBER + index.occupied = stat_poiindex.occupied;report_or_not_flag = (taskno MAX_ACT_TASK_NUMBER) & (N7StatItemValid(stat_item) & (act_task_tabletaskno.result_data != 0);1-3：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。示例：if (taskno max_act_task_number) & (tas

3、kid != 0) & (N7StatItemValid(stat_item) . / program codefor (i = 0, j = 0; (i buffer_keywordword_index.word_length) & (j new_keyword.word_length); i+, j+) . / program codefor (i = 0, j = 0; (i first_word_length) & (j ），后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够

4、清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在C/C+语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。示例：(1) 逗号只在后面加空格。int a, b, c;(2)!、+、-、&（地址运算符）等单目操作符前后不加空格。*p = a; / 内容操作*与内容之间flag = !is_empty; / 非操作!与内容之间p = &mem; / 地址操作& 与内容之间i+; / +,-与内容之间(3)-、.前后不加空格。p-id = pid; / -指针前后不加空

5、格(4) if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。if (a = b & c d)(5)比较操作符, 赋值操作符=、 +=前后加空格，算术操作符+、%，逻辑操作符&、&，位域操作符= MAX_TIME_VALUE) a = b + c;a *= 2;a = b 2;1-9：所有文件最后必须有一个空行，因为某些编译器没有这个空行会有编译错误，另外，没有空行也会引起Sourcesafe的diff工作不正常。1.2.Windows1-10：程序块的分界符（如C/C+语言的大括号和）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的

6、开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。示例：如下例子不符合规范。for (.) . / program codeif (.) . / program code void ExampleFunc( void ) . / program code 应如下书写。for (.) . / program codeif (.) . / program codevoid ExampleFunc( void ) . / program code1-11：C类的头文件定义，书写顺序为：1.public类型的变量/数据2

7、.public类型的函数3.protected类型的变量/数据4.protected类型的函数5.private类型的变量/数据6.private类型的函数对于Visual Studio Classwizard生成的内容，最后要按照该顺序整理。1-12：C类的头文件定义，相关的变量和函数应该写在一起，归类具有条理性，变量的个数清楚易读。1.3.嵌入式1-10： C/C+语言的 应该放在语句末尾，而与引用它们的语句左对齐。类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。示例：if (x is true) we do y

8、 do body of do-loop while (condition); if (x = y) . else if (x y) . else . 1-11： 对于函数来讲，与 各占一行。 int function(int x) body of function 2.注释2.1.公共部分2-1：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、功能、修改日志等。文件头的注释采用以下模板：/*+* Copyright (c) 1999-2005 IVT Corporation* All rights reserved.*

9、-*/ /*+Module Name: HelpFunc.cppAbstract: contentsRevision History:No. Date, Name, Contents-*/2-2：源文件头部应进行注释，列出：版权说明、模块目的/功能、修改日志等。文件头的注释采用以下模板：/*+* Copyright (c) 1999-2005 IVT Corporation* All rights reserved.* -*/ /*+Module Name: HelpFunc.cppAbstract: contentsRevision History:No. Date, Name, Conte

10、nts-*/2-3：函数头部应进行注释，列出：函数的目的/功能、参数说明、返回值等。函数的注释采用以下模板：/*+Description: This function isArguments: temp_addr in/out description(aligned)Return: description-*/2-4：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。2-5：注释的内容要清楚、明了，含义准确，防止注释二义性。说明：错误的注释不但无益反而有害。2-6：避免在注释中使用缩写，特别是非常用缩写。说明：在使用缩写时或之前，应对缩写进行必要的说明

11、。2-7：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面。示例：如下例子不符合规范。例1：/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;应如下书写/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_

12、ni = ssn_dataindex.ni;2-8：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。示例：/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */2-9：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位

13、置，不可放在下面；对结构中的每个域的注释放在此域的右方。示例：可按如下形式说明枚举/数据/联合结构。/* HCI Local Policy */struct LocalPolicyStru UCHAR local_role:2; /*SLR_MASTER，SLR_SLAVE or SLR_MASTER_SLAVE*/ UCHAR sec_mode:2; /*security mode 1, 2, 3*/ UCHAR auto_accept:1; /*auto-accept remote baseband connection request*/ UCHAR pairable:1; /*para

14、ble or unpairable*/ UCHAR visible:1; /*visible or unvisible*/ UCHAR lk_manage:1;2-10：全局变量要有较详细的注释，包括对其功能、取值范围、以及存取时注意事项等的说明。示例：/* The ErrorCode when SCCP translate */* Global Title failure, as follows */ / 变量作用、含义/* 0 SUCCESS 1 GT Table error */* 2 GT error Others no use */ / 变量取值范围/* only function

15、SCCPTranslate() in */* this modual can modify it, and other */* module can visit it through call */* the function GetGTTransErrorCode() */ / 使用方法BYTE g_GTTranErrorCode; 2-11：注释与所描述内容进行同样的缩排。说明：可使程序排版整齐，并方便注释的阅读与理解。示例：如下例子，排版不整齐，阅读稍感不方便。void example_fun( void )/* code one comments */ CodeBlock One /*

16、 code two comments */ CodeBlock Two应改为如下布局。void example_fun( void ) /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two2-12：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。示例：case CMD_UP: ProcessUp(); break;

17、case CMD_DOWN: ProcessDown(); break;case CMD_FWD: ProcessFwd(); ProcessCFW_B(); / now jump into case CMD_Acase CMD_A: ProcessA(); break;case CMD_B: ProcessB(); break;.2-13：避免在一行代码或表达式的中间插入注释。说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。2-14：注释应该说明程序的功能（What）和/或这样作的原因（Why），而不应该说明是怎样作的（How），怎样作的应该蕴含在代码之中。2-1：

18、通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。2-2：在代码的功能、意图层次上进行注释，提供有用、额外的信息。说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。示例：如下注释意义不大。/* if receive_flag is TRUE */if (receive_flag)而如下的注释则给出了额外有用的信息。 /* if mtp receive a message from links */if (receive_

19、flag)2-3：在程序块的结束行右方加注释标记，以表明某程序块的结束。说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。示例：参见如下例子。if (.) / program code while (index MAX_INDEX) / program code /* end of while (index MAX_INDEX) */ / 指明该条while语句结束 /* end of if (.)*/ / 指明是哪条if语句结束2.2.Windows2-15：文件的头部注释以及函数说明注释必须使用IVTCodeComment.dsm的宏工具产生的模板，或者是该宏工具产

20、生的注释的模板的完整拷贝。2.3.嵌入式2-15：注释使用 “/* */”，避免移植性问题。3.标识符命名3.1.公共部分3-1：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。缩写表见附录1。3-2：命名中若使用特殊约定或缩写，则要有注释说明。说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。3-3：自己特有的命名风格，要自始至终保持一致，不可来回变化。说明：个人的命名风格，在符合所在项

21、目组或产品组的命名规则的前提下，才可使用。（即命名规则中没有规定到的地方才可有个人命名风格）。3-4：常量和宏全用大写的字母，用下划线分割单词示例： /* controller to host flow control flags */#define HC2HOST_FC_OFF 0#define HC2HOST_FC_ACL 1#define HC2HOST_FC_SCO 2#define HC2HOST_FC_BOTH 33-5：静态变量加前缀s_3-6：如果不得已需要全局变量，则全局变量加前缀g_3-1：除非必要，不要用数字或较奇怪的字符来定义标识符。示例：如下命名，使人产生疑惑。#de

22、fine _EXAMPLE_0_TEST_#define _EXAMPLE_1_TEST_void set_sls00( BYTE sls );应改为有意义的单词命名#define _EXAMPLE_UNIT_TEST_#define _EXAMPLE_ASSERT_TEST_void SetUdtMsgSls( BYTE sls );3-2：在同一软件产品内，应规划好接口部分标识符（变量、结构、函数及常量）的命名，防止编译、链接时产生冲突。说明：对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。3-3：用正确的反义词组命名具有互斥意义的变量或相

23、反动作的函数等。说明：下面是一些在软件中常用的反义词组。add / remove begin / end create / destroy insert / delete first / last get / releaseincrement / decrement put / getadd / delete lock / unlock open / closemin / max old / new start / stopnext / previous source / target show / hidesend / receive source / destinationcut / pa

24、ste up / down示例：int min_sum;int max_sum;int add_user( BYTE *user_name );int delete_user( BYTE *user_name );3-4：除了编译开关/头文件等特殊应用，应避免使用_EXAMPLE_TEST_之类以下划线开始和结尾的定义。3.2.Windows3-7：类名和函数名用大写字母开头的单词组合而成示例： LRESULT CAsyncThread:OnSwitchRole(WPARAM wParam, LPARAM lParam)3-8：变量和参数以小写字母开头，采用大小写混排的方式，并使用匈牙利命名法匈牙利命名法见附录2示例： BOOL CBluetooth:Stop(BOOL bDeviceRemoved);3-9：成员变量加前缀m_3-10：对于变量命名，禁止取单个字符（如i、j、k.），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如i写成j），而编译时又检查不出来，有可能为