华为软件编程规范

Java语言编程规范（华为公司）DKBA华为技术有限公司企业技术规范DKBAXXXX-2001.12代替（DKBA200106-003）Java语言编程规范2001-12-XX发布2001-12-XX实施华为技术有限公司发布VVVVVVV VVVVVVVVVVVX。

XVX.X VX.X VX.X VX.XVX.X 目次前言 .............................................................................. .. (3)1 范围112 规范性引用文件113 术语和定义114 排版规范124.1 规则121.*程序块要采用缩进风格编写，缩进12的空格数为4个。

122.*分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。

在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

133.*较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。

134.*不允许把多个短语句写在一行中，即一行只写一条语句5.*if, for, do, while, case,13switch, default 等语句自占一行，且if, for, do, while等语句的执行语句无论多少都要加括号{}。

6.*相对独立的程序块之间、变量说明13之后必须加空行。

7.*对齐只使用空格键，不使用TAB键。

14VVVVVVV VVVVVVVVVVVX。

XVX.X VX.X VX.X VX.XVX.X 8.*在两个以上的关键字、变量、常量14进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。

华为软件编程规范和范例〔一〕=====[排版] ]=======.〔二〕======[注释]=======.〔三〕=====[标识符命名]=======.〔四〕=====[可读性]======.〔五〕=====[变量、结构]=====.〔六〕=====[函数、过程]=====.〔七〕=====[可测性]=====.〔八〕=====[程序效率]=====.〔九〕=====[质量保证]=====.〔十〕=====[代码编辑、编译、审查]=====.〔十一〕=====[代码测试、维护]=====.〔十二〕=====[宏]=====.〔一〕========[ 排版]========== ¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个说明：对于由开发工具自动生成的代码可以有不一致。

¹1-2：相对独立的程序块之间、变量说明之后必须加空行示例：如下例子不符合规范。

Int ni;if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;应如下书写Int ni;if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;¹1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读示例：perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN+ STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied= stat_poi[index].occupied;act_task_table[taskno].duration_true_or_false= SYS_get_sccp_statistic_state( stat_item );report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item))&& (act_task_table[taskno].result_data != 0));¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首示例：if ((taskno < max_act_task_number)&& (n7stat_stat_item_valid (stat_item))){... // program code}for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length)&& (j < NewKeyword.word_length); i++, j++){... // program code}for (i = 0, j = 0;(i < first_word_length) && (j < second_word_length);i++, j++){... // program code}¹1-5：若函数或过程中的参数较长，则要进行适当的划分示例：n7stat_str_compare((BYTE *) & stat_object,(BYTE *) & (act_task_table[taskno].stat_object),sizeof (_STAT_OBJECT));n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER+ index, stat_object );¹1-6：不允许把多个短语句写在一行中，即一行只写一条语句示例：如下例子不符合规范。

百度文库- 让每个人平等地提升自我目录1 排版 (2)4 可读性 (11)6 函数、过程 (13)7 可测性 (14)1 排版¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。

说明：对于由开发工具自动生成的代码可以有不一致。

¹1-2：相对独立的程序块之间、变量说明之后必须加空行。

示例：如下例子不符合规范。

if (!valid_ni(ni)){... epssn_index;repssn_ni = ssn_data[index].ni;应如下书写if (!valid_ni(ni)){... epssn_index;repssn_ni = ssn_data[index].ni;¹1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。

示例：= NO7_TO_STAT_PERM_COUNT_LEN+ STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_table[frame_id * STAT_TASK_CHECK_NUMBER +index].occupied= stat_poi[index].occupied;act_task_table[taskno].duration_true_or_false= SYS_get_sccp_statistic_state( stat_item );report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item)) &&(act_task_table[taskno].result_data != 0));¹1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。

华为软件编程规范软件编程规范(仅供内部使用)北京世纪百合科技有限公司Beijing Centurial Lily Technology Co.,Ltd.版权所有不得复制文档修改记录目录1.引言 (4)1.1目的 (4)1.2范围 (4)2.规范 (4)2.1文件 (4)2.2版面风格 (4)2.3标识符命名 (9)2.4函数与宏 (11)2.5代码的可靠性 (14)3.附录：通用类型的公共定义 (19)1.引言1.1目的本规范的目的在于增加源代码的可读性，减少程序员对代码理解上的偏差，使程序员能够编写出可靠的代码，降低代码维护成本。

1.2范围本规范内容涉及范围包括：文件、版面、注释、标识符、变量和结构、函数、宏以及可理解性等。

本规范适用于公司开发的所有软件产品。

在新软件的编码过程中本规范必须执行。

2.规范2.1文件2.1.1头文件的名称一律为小写，格式为“子系统名_文件名.h”。

例如：ipf_protocol.h等。

2.1.2头文件的格式如下：注释头，格式参见软件编程规范；头文件预编译开关开始，格式为：#ifndef 预编译开关#define 预编译开关其中预编译开关格式为：“_文件名_H”，其中文件名一律大写头文件内容；头文件预编译开关结束，格式为：#endif用来和头文件预编译开关的开始对应。

例如：以下为ipf_ip.h头文件的内容：/********************************** **************************Copyright (c) Lily Of The Century Technology Co., LTD.ALL RIGHTS RESERVEDDescription: // 用于详细说明此程序文件完成的主要功能*********************************** **************************/#ifndef _IPF_IP_H#define _IPF_IP_H...<头文件正文>...#endif2.1.3头文件的定义要有层次，禁止交叉引用。

华为代码规范目录1 概述 (5)1.1 编写目的 (5)1.2 文档约定 (5)1.3 预期的读者和阅读建议 (5)1.4 参考文献 (5)2 排版要求 (5)2.1 程序块缩进 (5)2.2 程序块之间空行 (5)2.3 长语句和长表达式 (6)2.4 循环、判断等长表达式或语句 (7)2.5 长参数 (7)2.6 短语句 (8)2.7 条件、循环语句 (8)2.8 语句对齐 (8)2.9 函数、过程和结构等语句块 (9)2.10 程序块分界符 (9)2.11 操作符前后空格 (10)2.12 其他 (11)3 注释 (11)3.1 有效注释量 (11)3.2 公司标识 (11)3.3 说明性文件 (12)3.4 源文件头 (13)3.5 函数头部说明 (13)3.6 注释与代码一致 (14)3.7 注释内容 (14)3.8 注释缩写 (14)3.9 注释位置 (14)3.10 变量、常量注释 (15)3.11 数据结构的注释 (15)3.12 全局变量 (16)3.13 注释缩排 (16)3.14 注释与代码之间空行 (17)3.15 变量定义、分支语句 (17)3.16 其他 (19)4 标识符命名 (20)4.1 命名清晰 (20)4.2 特殊命名需注释 (21)4.3 命名风格保持一致 (21)4.4 变量命名 (21)4.5 命名规范与系统风格一致 (21)4.6 其他 (22)5 可读性 (23)5.1 运算符优先级 (23)5.2 避免直接使用数字作为标识符 (23)5.3 其他 (24)6 变量、结构 (25)6.1 公共变量 (25)6.2 公共变量说明 (25)6.3 公共变量访问说明 (25)6.4 公共变量赋值 (26)6.5 防止局部变量与公共变量同名。

(26)6.6 严禁使用未经初始化的变量作为右值。

(26)6.7 其他 (26)7 函数、过程 (34)7.1 对所调用函数的错误返回码要仔细、全面地处理。

华为编程规范华为编程规范是指在华为公司内部进行软件开发时所遵守的一套规范和标准，旨在提高代码的质量和可维护性。

下面是华为编程规范的主要内容。

一、命名规范：1. 变量和函数名应采用有意义的名称，尽量避免使用缩写或简写。

2. 变量名和函数名应使用小驼峰命名法，即首字母小写，后续单词首字母大写。

3. 常量名应使用大写字母和下划线，以增加可读性。

4. 类名应使用大驼峰命名法，即每个单词首字母大写。

5. 文件名应与其中的公共类名一致。

二、注释规范：1. 在每个函数的开头添加函数的功能说明，参数说明和返回值说明。

2. 在关键性代码部分添加注释，说明代码的逻辑。

3. 在需要修正或改进的代码部分添加TODO注释，以便后续修复。

三、代码风格：1. 缩进使用4个空格而不是Tab键。

2. 每行代码的长度不能超过80个字符。

3. 在二元操作符两边添加空格，例如 a + b。

4. 大括号应另起一行，不应与关键字在同一行。

5. 每个语句结束后都应该添加分号。

四、异常处理：1. 捕获异常时应尽量具体，不应捕获顶层异常。

2. 异常处理代码应与正常逻辑代码分离，以提高代码的可读性。

3. 异常处理代码块应添加注释，说明捕获的异常类型和处理的方法。

五、函数规范：1. 函数的长度应控制在100行以内，避免函数过长和复杂。

2. 函数的参数应尽量少，可以通过封装成结构体或类的方式来减少参数数量。

3. 函数应只完成一个功能，不应既完成数据处理又完成界面显示等功能。

六、代码复用：1. 尽量使用现有的类和框架来实现功能，避免重复造轮子。

2. 重复的代码应抽取成函数或方法来复用，提高代码的可维护性。

3. 提高代码的可移植性，使其可以在不同的平台和环境下复用。

七、测试规范：1. 添加单元测试用例，覆盖所有的代码分支，确保代码的正确性。

2. 针对不同的输入情况，测试代码的边界问题和异常情况。

3. 添加性能测试用例，确保代码在大数据量和高并发情况下的性能表现。

华为各平台技能要求说明：下面各平台级别及技能要求都是华为项目所需要的，未列出的级别及技能华为10年还没有需求。

J2EE平台三级计算机相关专业，本科三年以上本领域工作经验；技能要求：掌握J2EE架构；熟练掌握IBM WSAD 版本5.1以上或IBM RAD开发工具；熟练掌握Struts框架开发技术；熟练掌握Java 语言编程技术；熟悉UML语言，能够理解UML设计图；熟练掌握Oracle SQL开发与存储过程开发。

具有三年以上的Java开发经验，2年以上的基于J2EE技术规范的WEB开发经验二级计算机相关专业，本科两年以上或大专四年以上本领域工作经验；技能要求：掌握Java编程语言；了解J2EE架构；熟练掌握java script，html、Jsp、Servlet、JavaBean等web 开发技术；掌握标准SQL语言，有Oracle Sql开发经验。

了解UML语言；掌握IBM WSAD 版本5.1以上或IBM RAD开发工具或Eclipse开发工具；熟悉WEB/J2EE服务器的使用，可熟练配置使用Tomcat,Apache。

参与过系统的设计与开发工作，2年以上Java开发经验。

Net平台三级计算机相关专业，本科三年以上本领域工作经验，技能要求：除满足二级人员要求外，熟练掌握.Net开发框架，熟练掌握开发和C＃开发；熟悉IIS服务器配置与管理；熟悉Web Service，精通XML文件的解析。

具有三年以上的.Net开发经验，1年以上的基于.Net 技术规范的WEB开发经验。

有能力解决项目组内重大问题、能指导设计开发二级计算机相关专业，本科两年以上或大专四年以上本领域工作经验，技能要求：掌握C#开发语言；熟悉.Net多层架构；熟练掌握java script，html、等web开发技术；有COM/COM+的开发经验；掌握标准SQL语言，有较好的基于Oracle或Sql Server的 Sql开发经验。

华为软件编程规范•全局函数、全局变量、宏、类型名、枚举名的命名，应当准确描述并全局唯一•在能够准确表达含义的前提下，局部变量，或结构体、联合体的成员变量，其命名应尽可能简短•LiteOS的对外API使用LOS_Module_Func的方式，如果有宾语采用前置的方式，比如：1.LOS_TaskCreate2.LOS_SwtmrStart3.LOS_SemPendkernel目录下内部模块间接口使用OsModuleFunc的方式，比如：1.OsTaskScan2.OsSwtmrStartarch目录需要给上层模块提供LowLevel接口，这部分接口采用ArchModuleFunc的方式。

其他情况可采用ModuleFunc的方式。

排版与格式•程序块采用缩进风格编写，使用空格而不是制表符（'\t'）进行缩进，每级缩进为4个空格•采用K&R风格作为大括号换行风格，即函数左大括号另起一行放行首，并独占一行，其他左大括号跟随语句放行末，右大括号独占一行，除非后面跟着同一语句的剩余部分，如if 语句的else/elseif或者分号，比如：1.struct MyType{//左大括号跟随语句放行末，前置1个空格2....3.};//右大括号后面紧跟分号1.int Foo(int a)2.{//函数左大括号独占一行，放行首3.if(a>0){//左大括号跟随语句放行末，前置1个空格4....5.}else{//右大括号、"else"、以及后续的左大括号均在同一行6....7.}//右大括号独占一行8....9.}•条件、循环语句使用大括号，比如：1.if(objectIsNotExist){//单行条件语句也加大括号2.return CreateNewObject();3.}1.while(condition){}//即使循环体是空，也应使用大括号1.while(condition){2.continue;//continue表示空逻辑，使用大括号3.}•case/default语句相对switch缩进一层，缩进风格如下：1.switch(var){2.case0://缩进一层3.DoSomething1();//缩进一层4.break;5.case1:6.DoSomething2();7.break;8.default:9.break;10.}•一行只写一条语句•一条语句不能过长，建议不超过120个字符，如不能缩短语句则需要分行写•换行时将操作符留在行末，新行进行同类对齐或缩进一层，比如：1.//假设下面第一行不满足行宽要求2.if(currentValue>MIN&&//换行后，布尔操作符放在行末3.currentValue<MAX){//与(&&)操作符的两个操作数同类对齐4.DoSomething();5....6.}1.//假设下面的函数调用不满足行宽要求，需要换行2.ReturnType result=FunctionName(paramName1,3.paramName2,4.paramName3);//保持与上方参数对齐1.ReturnType result=VeryVeryVeryLongFunctionName(//写入第1个参数后导致过长，直接换行2.paramName1,paramName2,paramName3);//换行后，4空格缩进一层1.//每行的参数代表一组相关性较强的数据结构，放在一行便于理解，此时可理解性优先于格式排版要求2.int result=DealWithStructLikeParams(left.x,left.y,//表示一组相关参数3.right.x,right.y);//表示另外一组相关参数•声明定义函数时，函数的返回类型以及其他修饰符，与函数名同行•指针类型"*"应该靠右跟随变量或者函数名，比如：1.int*p1;//Good：右跟随变量，和左边的类型隔了1个空格2.int*p2;//Bad：左跟随类型3.int*p3;//Bad：两边都没空格4.int*p4;//Bad：两边都有空格当"*"与变量或函数名之间有其他修饰符，无法跟随时，此时也不要跟随修饰符，比如：1.char*const VERSION="V100";//Good：当有const修饰符时，"*"两边都有空格2.int Foo(constchar*restrictp);//Good：当有restrict修饰符时，"*"两边都有空格•根据上下内容的相关程度，合理安排空行，但不要使用连续3个或更多空行•编译预处理的"#"统一放在行首，无需缩进。