华为软件编程规范总则Word文档下载推荐.docx
《华为软件编程规范总则Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《华为软件编程规范总则Word文档下载推荐.docx（54页珍藏版）》请在冰豆网上搜索。
修改规则2-2，要求头文件中必须有主要函数的功能说明
1999/02/01
1.05
修改规则2-10，取消有关“同一结构不同域的注释要对齐”的内容；
增加规则3-5：
命名不要采用大小写与下划线混排方式；
修改建议6-13，加入OOP方法的函数命名建议；
修改建议7-4为规则7-15，要求DEBUG版与RELEASE版统一维护；
修改规则2-14为建议2-6，建议注释使用中文；
增加规则9-16：
if语句加上else分支，switch语句加上default分支；
增加建议6-29：
调用函数时使用其返回值
修改规则1-1，增加说明，对开发工具自动生成的代码缩进空格以自动生成的为准
修改建议5-16，考虑字节对齐的问题
删除建议5-10声明变量的同时对变量进行初始化，原因是很多软件可以查出这种情况，强制初始化反而不妥，如全局变量在声明时初始化的情况。
1999/02/02
1.06
加入有关宏的三条规则。
修改建议2-4：
在程序块的结束行右方加注释标记。
增加建议3-5：
除特殊应用外避免下划线开始和结尾的定义。
修改建议5-15的示例，推荐以后使用BYTE、WORD数据类型等的自定义方式，而不是原来的_UC、_US方式。
统一修改示例。
修改建议9-2，避免嵌入式汇编。
增加建议9-13：
如果资源对语言敏感，将资源文件与源代码文件脱离。
目录
1排版
5
2注释
10
3标识符命名
17
4可读性
19
5变量
21
6函数、过程
28
7可测性
36
8程序效率
41
9质量保证
45
10代码编辑、编译、审查
52
11代码测试、维护
54
12宏
55
研究管理部技术管理处
为了提高源程序的质量和可维护性，最终提高公司软件产品生产力，我们有必要对公司软件产品的源程序的编写风格作出统一的规范约束。
本规范总则是独立于具体语言的编程规则的总的原则，针对不同编程语言或应用环境的编程规范在遵守本规范总则的基础上，还必须遵守相应语言和就用环境的编程规范。
本规范总则适用于公司所有产品以及对外合作委托开发产品的软件源程序。
本规范总则的内容包括：
排版、注释、标识符命名、变量使用、代码可测性、程序效率、质量保证、代码编译、单元测试、程序版本与维护等。
本规范总则的示例都以C语言为背景，采用以下的术语描述：
★规则：
编程时强制必须遵守的原则。
★建议：
编程时必须加以考虑的原则。
★说明：
对此规则或建议进行必要的解释。
★示例：
对此规则或建议从正、反两个方面给出例子。
本规范参照《交换业务部编程规范（试行）》、《无线业务部软件编程规范（第三版）》制定，根据各部门意见修改完成。
本规范在1999年2月4日前由各业务部会签后颁布执行。
研究技术管理处软件工程室将会同各业务部一起定期对规范的执行情况进行检查，对违规行为进行警告、通报批评、罚款100－500元等方式的处罚。
要求所有的新软件源程序必须按照规范要求编写，对于已有软件的源程序要求必须调动资源按照规范对源程序进行修改，要求在每次检查时源程序风格都应有进步，在1999年9月30日前，所有产品的源程序都必须符合本规范规定。
1-1：
程序块要采用缩进风格编写，缩进的空格数为4个。
说明：
对于由开发工具自动生成的代码可以有不一致。
1-2：
相对独立的程序块之间、变量说明之后必须加空行。
示例：
如下例子不符合规范。
if（!
valid_ni（ni））
{
...//programcode
}
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）））
for（i=0;
j=0;
（i<
BufferKeyword[word_index].word_length）
（j<
NewKeyword.word_length）;
i++;
j++）
first_word_length）&
second_word_length）;
...//programcode
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：
不允许把多个短语句写在一行中，即一行只写一条语句。
rect.length=0;
rect.width=0;
rect.width=0;
1-7：
if、while、for、default、do等语句自占一行。
if（pUserCR==NULL）return;
应如下书写：
if（pUserCR==NULL）
return;
1-8：
不要混合使用空格键和TAB键。
只要不混用，用不同的编辑器阅读程序时，不会因TAB键所设置的空格数目不同而造成程序布局不整齐。
1-9：
函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。
1-10：
程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。
在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
for（...）{
if（...）
{
}
voidexample_fun（void）
应如下书写。
for（...）
1-11：
在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；
进行非对等操作时，如果是关系密切的立即操作符（如－>
），后不应加空格。
采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如括号内侧（即左括号后面和右括号前面）不要加空格，多重括号间不必加空格，因为在C/C++语言中括号已经是最清晰的标志了。
在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。
给操作符留空格时不要连续留两个以上空格。
（1）逗号、分号只在后面加空格
inta,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=pid;
指针前后不加空格
（5）if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。
if（a>
=b&
c>
d）
一行程序以小于80字符为宜，不要写得过长。
不同类型的操作符混合使用时，即使实现优先级与实际需要相符，最好也使用括号隔离之，以便代码更加清晰。
如本来是正确的代码：
if（year%4==0||year%100!
=0&
year%400==0）
如果加上括号，则更清晰。
If（（year%4）==0||（year%100）!
（year%400）==0）
2-1：
一般情况下，源程序有效注释量必须在20％以上。
注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。
2-2：
说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：
版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。
下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/*************************************************
Copyright（C）,1988-1999,HuaweiTech.Co.,Ltd.
Filename:
//文件名
Author:
Version:
Date:
//作者、版本及完成日期
Description:
//用于详细说明此程序文件完成的主要功能，与其他模块或函数的接口，输//出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系
Others:
//其它内容的说明
FunctionList:
//主要函数列表，每条记录应包括函数名及功能简要说明
1.....
History:
//修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述
1.Date:
Modification:
2....
*************************************************/
2-3：
源文件头部应进行注释，列出：
版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
/************************************************************
FileName:
test.cpp
Version:
//模块描述
//版本信息
//主要函数及其功能
1.-------
//历史修改记录
<
author>
time>
version>
desc>
David96/10/121.0buildthismoudle
***********************************************************/
Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。
History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。
2-4：
函数头部应进行注释，列出：
函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。
下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。
Function:
//函数名称
//函数功能、性能等的描述
Calls:
//被本函数调用的函数清单
CalledBy:
//调用本函数的函数清单
TableAccessed:
//被访问的表（此项仅对于牵扯到数据库操作的程序）
TableUpdated:
//被修改的表（此项仅对于牵扯到数据库操作的程序）
Input:
//输入参数说明，包括每个参数的作
//用、取值说明及参数间关系。
Output:
//对输出参数的说明。
Return:
//函数返回值的说明
//其它说明
2-5：
边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。
不再有用的注释要删除。
2-6：
注释的内容要清楚、明了，含义准确，防止注释二义性。
错误的注释不但无益反而有害。
规则2-7：
避免在注释中使用缩写，特别是非常用缩写。
在使用缩写时或之前，应对缩写进行必要的说明。
2-8：
注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
例1：
/*getreplicatesubsystemindexandnetindicator*/
例2：
2-9：
对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。
变量、常量、宏的注释应放在其上方相邻位置或右方。
/*activestatistictasknumber*/
#defineMAX_ACT_TASK_NUMBER1000
#defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/
2-10：
数据结构声明（包括数组、结构、类、枚举等），如果其命名不是充分自注释的，必须加以注释。
对数据结构的注释应放在其上方相邻位置，不可放在下面；
对结构中的每个域的注释放在此域的右方。
可按如下形式说明枚举/数据/联合结构。
/*sccpinterfacewithsccpuserprimitivemessagename*/
enumSCCP_USER_PRIMITIVE
N_UNITDATA_IND,/*sccpnotifysccpuserunitdatacome*/
N_NOTICE_IND,/*sccpnotifyusertheNo.7networkcannot*/
/*transmissionthismessage*/
N_UNITDATA_REQ,/*sccpuser'
sunitdatatransmissionrequest*/
};
2-11：
全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
/*TheErrorCodewhenSCCPtranslate*/
/*GlobalTitlefailure,asfollows*///变量作用、含义
/*0－SUCCESS1－GTTableerror*/
/*2－GTerrorOthers－nouse*///变量取值范围
/*onlyfunctionSCCPTranslate（）in*/
/*thismodualcanmodifyit,andother*/
/*modulecanvisititthroughcall*/
/*thefunctionGetGTTransErrorCode（）*///使用方法
BYTEg_GTTranErrorCode;
2-12：
注释与所描述内容进行同样的缩排。
可使程序排版整齐，并方便注释的阅读与理解。
如下例子，排版不整齐，阅读稍感不方便。
/*codeonecomments*/
CodeBlockOne
/*codetwocomments*/
CodeBlockTwo
应改为如下布局。
2-13：
将注释与其上面的代码用空行隔开。
如下例子，显得代码过于紧凑。
/*codeonecomments*/
programcodeone
/*codetwocomments*/
programcodetwo
2-14：
对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。
2-15：
对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。
这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。
示例（注意红色部分）：
caseCMD_UP:
ProcessUp（）;
break;
caseCMD_DOWN:
ProcessDown（）;
caseCMD_FWD:
ProcessFwd（）;
if（...）
...
else
ProcessCFW_B（）;
//nowjumpintocaseCMD_A
caseCMD_A
升级会员 