华为的编程规范和范例

1、列表第一排6注释211指定3标识符名称184可读性205变量，结构226函数，进程287可测试性368计划效率409质量保证4410代码编辑、编译和审阅5011代码测试，维护5212宏53第一排1-1:程序块必须使用缩进样式创建，缩进空格数为4。说明：开发工具自动生成的代码可能不匹配。1-2:在相对独立的程序块之间，应在变量说明后添加空行。范例：下列范例不符合规格：If(！Valid_ni(ni)./程序代码repsn _ ind=SSN _ data索引。repsn _ indexrepsn _ ni=SSN _ data索引。ni；应该写如下If(！Valid_ni(ni)./程序代码re

2、psn _ ind=SSN _ data索引。repsn _ indexrepsn _ ni=SSN _ data索引。ni；1-3:长语句(80个字符)要分成多行写，长表达式要由低优先级运算符分新行写，运算符放在新行的开头，分的新行要适当地缩进，排版要整齐，语句要可读。示例：perm _ count _ msg . head . len=no7 _ to _ stat _ perm _ count _ lenSTAT _ SIZE _ PER _ FRAM * SIZE of(_ UL)；act _ task _ tableframe _ id * stat _ task _ check _

3、 number index。occupied=stat _ poi索引。occupiedact _ task _ tabletasknow。duration _ true _ or _ false=sys _ get _ SCCP _ statistic _ state(stat _ item)；report _ or _ not _ flag=(tasknos max _ act _ task _ number)(n 7stat _ stat _ item _ valid(stat _ item)(act _ task _ tabletasknow)。result _ data！=0)1-4

4、:在循环、判断等语句中，如果有较长的表达式或语句，则将其有效地拆分，较长的表达式从低优先级运算符拆分新行，运算符位于新行的开头。示例：if(tasknomax _ act _ task _ number)(n 7 stat _ stat _ item _ valid(stat _ item)./程序代码For (i=0，j=0)；(I buffer keyword word _ index)。word _ length)(j new keyword . word _ length)；I，j)./程序代码For (i=0，j=0)；(I first _ word _ length)(j seco

5、nd _ word _ length)；I，j)./程序代码1-5:如果函数或进程的参数很长，则进行相应的划分。示例：n7stat _ str _ compare(byte *)stat _ object，(byte *)(act _ task _ tabletasknow)。stat _ object)、Sizeof (_STAT_OBJECT) n7stat _ flash _ act _ duration(stat _ item，frame _ id * stat _ task _ check _ number)Index、stat _ object)；1-6:一行不能写几个短语句。也就

6、是说，每行不能只写一个语句。范例：下列范例不符合规格：rect . length=0；rect . width=0；应该写如下rect . length=0；rect . width=0；1-7: if、for、do、while、case、switch、default等语句属于一行，并且if、for、do、while等语句的执行语句部分包含任意数量的括号范例：下列范例不符合规格：if(puser Cr=NULL)return；应该写如下：If (pUserCR=NULL)Return1-8:仅使用空格键进行排序，不使用TAB键。说明：避免使用其他编辑器读取程序时，由于TAB键设置的空格数不同，

7、程序布局不会整齐，不要使用BC作为编辑器组合版本。BC自动将8个空格更改为一个选项卡，因此使用BC组合的大多数版本可能会缩进。1-9:函数或过程的开始、结构定义和循环、判断等语句中的代码必须采用缩进格式，对于case语句，必须遵循语句的缩进要求。1-10:程序块中的分界符号(如C/C语言中的花括号“”和“”)必须单独位于同一列中(每行一个)，并与引用它们的语句左对齐。函数体开始、类定义、结构定义、枚举定义和if、for、do、while、switch、case语句中的程序将如上所示缩进。范例：下列范例不符合规格：For(.)符号./程序代码If(.）./程序代码Void example_fun

8、(void)./程序代码应该写如下。For(.）./程序代码If(.）./程序代码Void example_fun(void)./程序代码1-11:当两个或多个关键字、变量、常量相等时，在它们之间的运算符之前、之后或前后放置空格。执行非对等操作时，对于关系密切的立即操作符(例如-)，不应在后面加空格。说明：以这种松散的方式编写代码的目的是使代码清晰。保留空格的明确性是相对的，因此已经非常明确的语句不需要空格，如果语句足够明确，则括号内(即左括号后和右括号前)不需要空格，多个括号之间也不需要空格。在C/C语言中，括号已经是最明显的表示。长语句中的空格太多，必须全局明确，本地不能有空格。在运算符中

9、放置空格时，不要连续放置多个空格。示例：(1)逗号，分号后仅添加空格。Int a、b、c；(2)在比较运算符、赋值运算符“=”、“=”、算术运算符“”、“%”、逻辑运算符“”、“”、位域运算符“”、“”等双目运算符的前后添加空格。If (current_time=MAX_TIME_VALUE)a=b c；a*=2；a=b 2；(3)“！”，“”、“-”、“”(地址运算符)等一元运算符的前后不要包含空格。* p=a；/在内容操作“*”和内容之间Flag=！IsEmpty/非操作性“！”内容之间P=mem/地址操作“”和内容之间I；/“，”-“和内容之间(4)“-”、“.”前后没有空格。p-id=

10、PID；/“-”指针前后没有空格(5)必须在if、for、while、switch等后面的括号之间放置空格，这样关键字(如if)才会更加突出和明显。If (a=b c d)1-1:一行程序最好写得小于80个字符，不要写得太长。注释22-1:通常，源程序有效注释量应大于20%。说明：说明的原则有助于对程序的阅读理解，在这里全部加起来即可，说明不能太多或太少，说明语言要准确、理解、简洁。2-2:头文件。h文件，Inc文件，def文件，编译说明文件。注释文件(如CFG)必须注释头部，注释还必须对函数功能进行简要说明，包括版权说明、版本号、创建日期、作者、内容、功能、与其他文件的关系、修改日志、标题文

11、件的注释。示例：除了以下标题文件中的标题注释比较标准外，还不仅限于此格式，但建议包括以上信息。/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *版权所有(c)，1988-1999，huaweitech.co .ltd文件name: /文件名author : version : date :/作者、版本和完成日期与Description: /其他模块一起使用，详细说明完成此程序文件的主要功能/或函数的接口、输出值、值范围、语义和参数之间的控制/系统、顺序、独立或相依性ot

12、hers 3360/其他内容的说明Function List: /每个记录必须包含函数名称和功能的简要说明1.history 3360/修改历史记录列表。每个修正历史记录必须包含修正日期，修正/人员和修改1.日期：Author:Modification:2.* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *2-3:源文件的头应包含版权说明、版本号、创建日期、作者、模块目的/功能、主要功能和功能、修改日志等注释。示例：除了以下源文件中的标题注释比较标准外，还不仅限于此格式，但建议包括以上信息。

13、/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *版权所有(c)，1988-1999，huaweitech.co .ltdFileName: test.cppAuthor :版本： date :Description: /模块说明version 3360/版本信息Function List: /主要函数及其功能1.-history 3360/历史修改历史记录大卫96/10/12 1.0版本this moudle* * * * * * * * * * * * * *

14、* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *说明：Description描述了此文档的内容、功能、内部部分的关系以及此文档与其他文档的关系。History是修正历史记录列表，每个修正历史记录应包含修正日期、修正者和修正者的概述。2-4:必须注释函数头，如函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。示例：下面此函数的注释比较标准不仅局限于此格式，还建议包含上述信息。/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *function 3360/函数名Description: /函数功能、性能等的说明Calls: /此函数调用的函数列表Called By: /调用此函数的函数列表table accessed 3360/正在访问的表(仅限于与数据库活动相关的程序)Table Updated: /修改的表(此条目仅适用于与数据库操作相关的程序。)。）Input: /输入参数说明，包括每个参数的说明/使用、值说明和参数