华为代码规范文档.docx

上传人:b****1 文档编号:1713046 上传时间:2022-10-23 格式:DOCX 页数:57 大小:52.58KB
下载 相关 举报
华为代码规范文档.docx_第1页
第1页 / 共57页
华为代码规范文档.docx_第2页
第2页 / 共57页
华为代码规范文档.docx_第3页
第3页 / 共57页
华为代码规范文档.docx_第4页
第4页 / 共57页
华为代码规范文档.docx_第5页
第5页 / 共57页
点击查看更多>>
下载资源
资源描述

华为代码规范文档.docx

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

华为代码规范文档.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_pare((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******pany*/

/*********所有1996-1998*/

/**/

/*PROPRIETARYRIGHTSof******panyareinvolvedinthe      */

/*subjectmatterofthismaterial.Allmanufacturing,reproduction,use,*/

/*andsalesrightspertainingtothissubjectmatteraregovernedbythe*/

/*licenseagreement.Therecipientofthissoftwareimplicitlyaccepts*/

/*thetermsofthelicense.*/

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

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

/**/

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

3.3说明性文件

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

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

例如:

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

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

Copyright(C),1996-1998,****x.Co.,Ltd.

Filename:

//文件名

Author:

Version:

Date:

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

Description:

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

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

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

Others:

//其它容的说明

FunctionList:

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

1.....

History:

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

//者及修改容简述

1.Date:

Author:

Modification:

2....

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

3.4

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

当前位置:首页 > 自然科学 > 化学

copyright@ 2008-2022 冰豆网网站版权所有

经营许可证编号:鄂ICP备2022015515号-1