华为代码规范文档.docx

上传人:b****2 文档编号:17201579 上传时间:2023-07-22 格式:DOCX 页数:69 大小:53.19KB
下载 相关 举报
华为代码规范文档.docx_第1页
第1页 / 共69页
华为代码规范文档.docx_第2页
第2页 / 共69页
华为代码规范文档.docx_第3页
第3页 / 共69页
华为代码规范文档.docx_第4页
第4页 / 共69页
华为代码规范文档.docx_第5页
第5页 / 共69页
华为代码规范文档.docx_第6页
第6页 / 共69页
华为代码规范文档.docx_第7页
第7页 / 共69页
华为代码规范文档.docx_第8页
第8页 / 共69页
华为代码规范文档.docx_第9页
第9页 / 共69页
华为代码规范文档.docx_第10页
第10页 / 共69页
华为代码规范文档.docx_第11页
第11页 / 共69页
华为代码规范文档.docx_第12页
第12页 / 共69页
华为代码规范文档.docx_第13页
第13页 / 共69页
华为代码规范文档.docx_第14页
第14页 / 共69页
华为代码规范文档.docx_第15页
第15页 / 共69页
华为代码规范文档.docx_第16页
第16页 / 共69页
华为代码规范文档.docx_第17页
第17页 / 共69页
华为代码规范文档.docx_第18页
第18页 / 共69页
华为代码规范文档.docx_第19页
第19页 / 共69页
华为代码规范文档.docx_第20页
第20页 / 共69页
亲,该文档总共69页,到这儿已超出免费预览范围,如果喜欢就下载吧!
下载资源
资源描述

华为代码规范文档.docx

《华为代码规范文档.docx》由会员分享,可在线阅读,更多相关《华为代码规范文档.docx(69页珍藏版)》请在冰点文库上搜索。

华为代码规范文档.docx

华为代码规范文档

 

代码规范文档

 

 

1概述

1.1编写目的

为规范软件开发人员的代码编写提供参考依据和统一标准。

1.2文档约定

说明本文档中所用到的专用术语定义或解释,缩略词定义。

1.3预期的读者和阅读建议

本文档适用于所有软件开发人员。

1.4参考文献

列出有关的参考文件,如:

a.属于本项目的其他已发表文件;

b.本文件中各处引用的文档资料。

列出这些文件的标题、作者,说明能够得到这些文件资料的来源。

2排版要求

2.1程序块缩进

程序块要采用缩进风格编写,缩进的空格数为4个。

说明:

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

2.2程序块之间空行

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

示例:

如下例子不符合规范。

if(!

valid_ni(ni))

{

...//programcode

}

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

应如下书写

if(!

valid_ni(ni))

{

...//programcode

}

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

2.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

&&(n7stat_stat_item_valid(stat_item))

&&(act_task_table[taskno].result_data!

=0));

2.4循环、判断等长表达式或语句

循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。

示例:

if((taskno

&&(n7stat_stat_item_valid(stat_item)))

{

...//programcode

}

for(i=0,j=0;(i

&&(j

{

...//programcode

}

for(i=0,j=0;

(i

i++,j++)

{

...//programcode

}

2.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);

2.6短语句

不允许把多个短语句写在一行中,即一行只写一条语句。

示例:

如下例子不符合规范。

rect.length=0;rect.width=0;

应如下书写

rect.length=0;

rect.width=0;

2.7条件、循环语句

if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

示例:

如下例子不符合规范。

if(pUserCR==NULL)return;

应如下书写:

if(pUserCR==NULL)

{

return;

}

2.8语句对齐

对齐只使用空格键,不使用TAB键。

说明:

以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐,

不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键,因此使用BC合入的版本大多会将缩进变乱。

2.9函数、过程和结构等语句块

函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。

2.10程序块分界符

程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。

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

示例:

如下例子不符合规范。

for(...){

...//programcode

}

if(...)

{

...//programcode

}

voidexample_fun(void)

{

...//programcode

}

应如下书写。

for(...)

{

...//programcode

}

if(...)

{

...//programcode

}

voidexample_fun(void)

{

...//programcode

}

2.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.12其他

2.12.1一行程序以小于80字符为宜,不要写得过长。

3注释

3.1有效注释量

一般情况下,源程序有效注释量必须在20%以上。

说明:

注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不

能太少,注释语言必须准确、易懂、简洁。

3.2公司标识

在头文件中加入公司标识。

示例如下:

**************************************************************************/

/*                                                                      */

/*Copyright(c)1996-1998 XXXXXXCompany                        */

/*                 xxxxxxxx 版权所有1996-1998 */

/*                                                                      */

/*PROPRIETARYRIGHTSof XXXXXXCompany areinvolvedinthe       */

/*subject matterofthismaterial. Allmanufacturing,reproduction,use,*/

/*and salesrightspertainingtothissubjectmatteraregovernedbythe */

/*licenseagreement. Therecipientofthissoftwareimplicitlyaccepts*/

/*thetermsofthelicense.                                            */

/*本软件文档资料是xxx公司的资产,任何人士阅读和使用本资料必须获得  */

/*相应的书面授权,承担保密责任和接受相应的法律约束.                     */

/*                                                                      */

/**************************************************************************/

3.3说明性文件

说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:

版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。

示例:

下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

/*************************************************

Copyright(C),1996-1998,xxxxx.Co.,Ltd.

Filename:

//文件名

Author:

Version:

Date:

//作者、版本及完成日期

Description:

//用于详细说明此程序文件完成的主要功能,与其他模块

//或函数的接口,输出值、取值范围、含义及参数间的控

//制、顺序、独立或依赖等关系

Others:

//其它内容的说明

FunctionList:

//主要函数列表,每条记录应包括函数名及功能简要说明

1.....

History:

//修改历史记录列表,每条修改记录应包括修改日期、修改

//者及修改内容简述

1.Date:

Author:

Modification:

2....

*************************************************/

3.4源文件头

源文件头部应进行注释,列出:

版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。

示例:

下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

/************************************************************

Copyright(C),1988-1999,XxxxxxTech.Co.,Ltd.

FileName:

test.cpp

Author:

Version:

Date:

Description:

//模块描述

Version:

//版本信息

FunctionList:

//主要函数及其功能

1.-------

History:

//历史修改记录

David96/10/121.0buildthismoudle

***********************************************************/

说明:

Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。

History是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。

3.5函数头部说明

函数头部应进行注释,列出:

函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。

示例:

下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

/*************************************************

Function:

//函数名称

Description:

//函数功能、性能等的描述

Calls:

//被本函数调用的函数清单

CalledBy:

//调用本函数的函数清单

TableAccessed:

//被访问的表(此项仅对于牵扯到数据库操作的程序)

TableUpdated:

//被修改的表(此项仅对于牵扯到数据库操作的程序)

Input:

//输入参数说明,包括每个参数的作

//用、取值说明及参数间关系。

Output:

//对输出参数的说明。

Return:

//函数返回值的说明

Others:

//其它说明

*************************************************/

3.6注释与代码一致

边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。

不再有用的注释要删除。

3.7注释内容

注释的内容要清楚、明了,含义准确,防止注释二义性。

说明:

错误的注释不但无益反而有害。

3.8注释缩写

避免在注释中使用缩写。

说明:

在使用缩写时或之前,应对缩写进行必要的说明。

3.9注释位置

注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。

示例:

如下例子不符合规范。

例1:

/*getreplicatesubsystemindexandnetindicator*/

 

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;

/*getreplicatesubsystemindexandnetindicator*/

应如下书写

/*getreplicatesubsystemindexandnetindicator*/

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

3.10变量、常量注释

对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。

变量、常量、宏的注释应放在其上方相邻位置或右方。

示例:

/*activestatistictasknumber*/

#defineMAX_ACT_TASK_NUMBER1000

#defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/

3.11数据结构的注释

数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。

对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。

示例:

可按如下形式说明枚举/数据/联合结构。

/*sccpinterfacewithsccpuserprimitivemessagename*/

enumSCCP_USER_PRIMITIVE

{

N_UNITDATA_IND,/*sccpnotifysccpuserunitdatacome*/

N_NOTICE_IND,/*sccpnotifyusertheNo.7networkcannot*/

/*transmissionthismessage*/

N_UNITDATA_REQ,/*sccpuser'sunitdatatransmissionrequest*/

};

3.12全局变量

全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

示例:

/*TheErrorCodewhenSCCPtranslate*/

/*GlobalTitlefailure,asfollows*///变量作用、含义

/*0-SUCCESS1-GTTableerror*/

/*2-GTerrorOthers-nouse*///变量取值范围

/*onlyfunctionSCCPTranslate()in*/

/*thismodualcanmodifyit,andother*/

/*modulecanvisititthroughcall*/

/*thefunctionGetGTTransErrorCode()*///使用方法

BYTEg_GTTranErrorCode;

3.13注释缩排

注释与所描述内容进行同样的缩排。

说明:

可使程序排版整齐,并方便注释的阅读与理解。

示例:

如下例子,排版不整齐,阅读稍感不方便。

voidexample_fun(void)

{

/*codeonecomments*/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo

}

应改为如下布局。

voidexample_fun(void)

{

/*codeonecomments*/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo

}

3.14注释与代码之间空行

将注释与其上面的代码用空行隔开。

示例:

如下例子,显得代码过于紧凑。

/*codeonecomments*/

programcodeone

/*codetwocomments*/

programcodetwo

应如下书写

/*codeonecomments*/

programcodeone

/*codetwocomments*/

programcodetwo

3.15变量定义、分支语句

对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。

说明:

这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。

示例(注意斜体加粗部分):

caseCMD_UP:

ProcessUp();

break;

caseCMD_DOWN:

ProcessDown();

break;

caseCMD_FWD:

ProcessFwd();

if(...)

{

...

break;

}

else

{

ProcessCFW_B();//nowjumpintocaseCMD_A

}

caseCMD_A:

ProcessA();

break;

caseCMD_B:

ProcessB();

break;

caseCMD_C:

ProcessC();

break;

caseCMD_D:

ProcessD();

break;

...

3.16其他

3.16.1避免在一行代码或表达式的中间插入注释。

说明:

除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。

3.16.2通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。

说明:

清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。

3.16.3在代码的功能、意图层次上进行注释,提供有用、额外的信息。

说明:

注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。

示例:

如下注释意义不大。

/*ifreceive_flagisTRUE*/

if(receive_flag)

而如下的注释则给出了额外有用的信息。

/*ifmtpreceiveamessagefromlinks*/

if(receive_flag)

3.16.4在程序块的结束行右方加注释标记,以表明某程序块的结束。

说明:

当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。

示例:

参见如下例子。

if(...)

{

//programcode

while(index

{

//programcode

}/*endofwhile(index

展开阅读全文
相关资源
猜你喜欢
相关搜索
资源标签

当前位置:首页 > 医药卫生 > 基础医学

copyright@ 2008-2023 冰点文库 网站版权所有

经营许可证编号:鄂ICP备19020893号-2