华为：《编程规范与案例》目录

软件编程规范总则 2注释 12-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有 用的注释要删除 2-6:注释的内容要清楚、明了,含义准确,防止注释二义性。 说明:错误的注释不但无益反而有害 规则2-7:避免在注释中使用缩写,特别是非常用缩写。 说明:在使用缩写时或之前,应对缩写进行必要的说明。 12-8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释) 相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开 示例:如下例子不符合规范。 例1: /* get replicate sub system index and net indicator * repssn ind ssn data[index]. repssn index repssn ni ssn data [index]. ni 例 repssn ind ssn data[index]. reps sn indexi ssn ni ssn data [index]. nii / get replicate sub system index and net indicator * 应如下书写 /* get replicate sub system index and net indicator * ind =ssn data[index]. reps sn index repssn ni ssn data [index]n 12-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加 以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。 / active statistic tas k number * de fine MAX ACT TASK NUMBER 1000 仅供内部使用

软件编程规范总则 2 注释 仅供内部使用 11 ¹2-5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有 用的注释要删除。 ¹2-6：注释的内容要清楚、明了，含义准确，防止注释二义性。 说明：错误的注释不但无益反而有害。 规则2-7：避免在注释中使用缩写，特别是非常用缩写。 说明：在使用缩写时或之前，应对缩写进行必要的说明。 ¹2-8：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释） 相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。 示例：如下例子不符合规范。 例 1： /* get replicate sub system index and net indicator */ repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni; 例 2： repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni; /* get replicate sub system index and net indicator */ 应如下书写 /* get replicate sub system index and net indicator */ repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni; ¹2-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加 以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。 示例： /* active statistic task number */ #define MAX_ACT_TASK_NUMBER 1000

软件编程规范总则 注释 #de fine MAX ACT TASK NUMBER 1000/* active statistic task number * 12-10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须 加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注 释放在此域的右方 示例:可按如下形式说明枚举/数据/联合结构。 /* sccp interface with sccp user primitive message name * enum SCCP USER PRIMITI N UNITDATA IND, /* sccp notify sccp user unit data come N NOTICE IND, / sccp notify user the No. 7 net work can not * / transmission this me ssage * N UNITDATA REQ,/* sccp user's unit data transmission request*/ 2-11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及 存取时注意事项等的说明。 示例 / The Errorcode when sccp translate * / Global Title failure, as follows * /变量作用、含义 / 0- SUCCESS 1- GT Table error * /变量取值范围 / only function SCCPTranslate() in * / this modual can modify it, and other * /* the function GetGTTransError code()*///使用方法 BYTe g GTTranError Code 2-12:注释与所描述内容进行同样的缩排 说明:可使程序排版整齐,并方便注释的阅读与理解, 示例:如下例子,排版不整齐,阅读稍感不方便 le fun( void 仅供内部使用12

软件编程规范总则 2 注释 仅供内部使用 12 #define MAX_ACT_TASK_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 come */ N_NOTICE_IND, /* sccp notify user the No.7 network can not */ /* transmission this message */ N_UNITDATA_REQ, /* sccp user's unit data 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 modify it, and other */ /* module can visit it through call */ /* the function GetGTTransErrorCode() */ // 使用方法 BYTE g_GTTranErrorCode; ¹2-12：注释与所描述内容进行同样的缩排。 说明：可使程序排版整齐，并方便注释的阅读与理解。 示例：如下例子，排版不整齐，阅读稍感不方便。 void example_fun( void ) { /* code one comments */ CodeBlock One

软件编程规范总则 2注释 Codeblock Two 应改为如下布局 void example fun( void Codeblock one / code two comments * Codeblock Two 12-13:将注释与其上面的代码用空行隔开。 示例:如下例子,显得代码过于紧凑 / code one comments * program code one / code two comments * program code two 应如下书写 / code one comments * program code one / code two comments * 2-14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。 说明:这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮 助更好的理解程序,有时甚至优于看设计文档。 2-15:对于 switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下 个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。 说明:这样比较清楚程序编写者的意图,有效防止无故遗漏 break语句 仅供内部使用

软件编程规范总则 2 注释 仅供内部使用 13 /* code two comments */ CodeBlock Two } 应改为如下布局。 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 two ¹2-14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。 说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮 助更好的理解程序，有时甚至优于看设计文档。 ¹2-15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一 个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。 说明：这样比较清楚程序编写者的意图，有效防止无故遗漏 break 语句

软件编程规范总则 2注释 示例(注意斜体加粗部分) case CMD UP break case CMD dowN Proces sDown ( break case CMD ewd if(...) break else ProcessCEWB(), / now jump into case CMD A case CMD A. break case break case CMD c Processc (i break case CMd D ProcessD O 仅供内部使用14

软件编程规范总则 2 注释 仅供内部使用 14 示例（注意斜体加粗部分）： case CMD_UP: ProcessUp(); break; case CMD_DOWN: ProcessDown(); break; case CMD_FWD: ProcessFwd(); if (...) { ... break; } else { ProcessCFW_B(); // now jump into case CMD_A } case CMD_A: ProcessA(); break; case CMD_B: ProcessB(); break; case CMD_C: ProcessC(); break; case CMD_D: ProcessD();

软件编程规范总则 2注释 break %2-1:遵兔在一行代码成表达式的中闻插入注释。 说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。 %22:通过对数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为 自注释的。 说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释 %23:在代码的功舵、意图层上进行注释,提供有用、颜外的信息 说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读 者理解代码,防止没必要的重复注释信息。 示例:如下注释意义不大。 /* if receive flag is TRUE * if (receive flag) 而如下的注释则给出了额外有用的信息。 /* if mtp receive a mes sage from links * if (receive flag) %2-4:在程序块的结束行右方加注释标记以表明某程序块的结束。 说明:当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。 示例:参见如下例子。 if(...) // program code hile (inde MAX INDEX) program code /+ end of while( index< MAX INDEX)*///指明该条 while语句结 束 }/* end of if(..)*///指明是哪条if语句结束 仅供内部使用

软件编程规范总则 2 注释 仅供内部使用 15 break; ... ½2-1：避免在一行代码或表达式的中间插入注释。 说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。 ½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 code while (index < MAX_INDEX) { // program code } /* end of while (index < MAX_INDEX) */ // 指明该条 while 语句结 束 } /* end of if (...)*/ // 指明是哪条 if 语句结束