华为软件编程规范和范例Word格式文档下载.docx
《华为软件编程规范和范例Word格式文档下载.docx》由会员分享,可在线阅读,更多相关《华为软件编程规范和范例Word格式文档下载.docx(42页珍藏版)》请在冰豆网上搜索。
for(i=0,j=0;
(i<
BufferKeyword[word_index].word_length)
(j<
NewKeyword.word_length);
i++,j++)
first_word_length)&
second_word_length);
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.7if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。
if(pUserCR==NULL)return;
if(pUserCR==NULL)
return;
1.8对齐只使用空格键,不使用TAB键。
以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐,不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键,因此使用BC合入的版本大多会将缩进变乱。
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)
2.注释
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:
//模块描述
//版本信息
//主要函数及其功能
//历史修改记录
<
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
应改为如下布局。
/*codeonecomments*/
2.13将注释与其上面的代码用空行隔开。
如下例子,显得代码过于紧凑。
programcodeone
/*codetwocomments*/
programcodetwo
2.14对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。
这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。
2.15对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。
这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。
示例(注意斜体加粗部分):
caseCMD_UP:
ProcessUp();
break;
caseCMD_DOWN:
ProcessDown();
caseCMD_FWD:
ProcessFwd();
...
else
ProcessCFW_B();
//nowjumpintocaseCMD_A
caseCMD_A:
ProcessA();
caseCMD_B:
ProcessB();
caseCMD_C:
ProcessC();
caseCMD_D:
ProcessD();
...
3.标识符命名
3.1标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。
较短的单词可通过去掉“元音”形成缩写;
较长的单词可取单词的头几个字母形成缩写;
一些单词有大家公认的缩写。
如下单词的缩写能够被大家基本认可。
temp可缩写为tmp;
临时
flag可缩写为flg;
标志
statistic可缩写为stat;
统计
increment可缩写为inc;
增量
message可缩写为msg;
消息
3.2命名中若使用特殊约定或缩写,则要有注释说明。
应该在源文件的开始之处,对文件中所使用的缩写或约定,特别是特殊的缩写,进行必要的注释说明。
3.3自己特有的命名风格,要自始至终保持一致,不可来回变化。
个人的命名风格,在符合所在项目组或产品组的命名规则的前提下,才可使用。
(即命名规则中没有规定到的地方才可有个人命名风格)。
3.4对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。
变量,尤其是局部变量,如果用单个字符表示,很容易敲错(如i写成j),而编译时又检查不出来,有可能为了这个小小的错误而花费大量的查错时间。
下面所示的局部变量名的定义方法可以借鉴。
intliv_Width
其变量名解释如下:
l局部变量(Local)(其它:
g全局变量(Global)...)
i数据类型(Interger)
v变量(Variable)(其它:
c常量(Const)...)
Width变量含义
这样可以防止局部变量与全局变量重名。
3.5命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,比如采用UNIX的全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方式,用作特殊标识如标识成员变量或全局变量的m_和g_,其后加上大小写混排的方式是允许的。
Add_User不允许,add_user、AddUser、m_AddUser允许。
4.可读性
4.1注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。
防止阅读程序时产生误解,防止因默认的优先级与设计思想不符而导致程序出错。
下列语句中的表达式
word=(high<
8)|low
(1)
if((a|b)&
(a&
c))
(2)
if((a|b)<
(c&
d))(3)
如果书写为:
high<
8|low
a|b&
a&
c
a|b<
c&
d
由于
8|low等价于(high<
8)|low
c等价于(a|b)&
c)
故
(1)
(2)不会出错,但语句不易理解,而
d等价于a|(b<
c)&
故(3)造成了判断条件出错。
4.2避免使用不易理解的数字,用有意义的标识来替代。
涉及物理状态或者含有物理意义的常量,不应直接使用数字,必须用有意义的枚举或宏来代替。
如下的程序可读性差。
if(Trunk[index].trunk_state==0)
Trunk[index].trunk_state=1;
应改为如下形式。
#defineTRUNK_IDLE0
#defineTRUNK_BUSY1
if(Trunk[index].trunk_state==TRUNK_IDLE)
Trunk[index].trunk_state=TRUNK_BUSY;
5.变量、结构
5.1去掉没必要的公共变量。
公共变量是增大模块间耦合的原因之一,故应减少没必要的公共变量以降低模块间的耦合度。
5.2仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。
在对变量声明的同时,应对其含义、作用及取值范围进行注释说明,同时若有必要还