华为代码综合规范文档Word文档下载推荐.docx
- 文档编号:18171695
- 上传时间:2022-12-13
- 格式:DOCX
- 页数:57
- 大小:52.71KB
华为代码综合规范文档Word文档下载推荐.docx
《华为代码综合规范文档Word文档下载推荐.docx》由会员分享,可在线阅读,更多相关《华为代码综合规范文档Word文档下载推荐.docx(57页珍藏版)》请在冰豆网上搜索。
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));
2.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++)
(i<
first_word_length)&
second_word_length);
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(...){
if(...)
{
}
voidexample_fun(void)
应如下书写。
for(...)
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
Version:
Date:
//模块描述
//版本信息
//重要函数及其功能
1.-------
//历史修改记录
<
author>
time>
version>
desc>
David96/10/121.0buildthismoudle
***********************************************************/
Description一项描述本文献内容、功能、内部各某些之间关系及本文献与其他文献关系等。
History是修改历史记录列表,每条修改记录应涉及修改日期、修改者及修改内容简述。
3.5函数头部阐明
函数头部应进行注释,列出:
函数目/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
下面这段函数注释比较原则,固然,并不局限于此格式,但上述信息建议要包括在内。
Function:
//函数名称
//函数功能、性能等描述
Calls:
//被本函数调用函数清单
CalledBy:
//调用本函数函数清单
TableAccessed:
//被访问表(此项仅对于牵扯到数据库操作程序)
TableUpdated:
//被修改表(此项仅对于牵扯到数据库操作程序)
Input:
//输入参数阐明,涉及每个参数作
//用、取值阐明及参数间关系。
Output:
//对输出参数阐明。
Return:
//函数返回值阐明
//其他阐明
3.6注释与代码一致
边写代码边注释,修改代码同步修改相应注释,以保证注释与代码一致性。
不再有用注释要删除。
3.7注释内容
注释内容要清晰、明了,含义精确,防止注释二义性。
错误注释不但无益反而有害。
3.8注释缩写
避免在注释中使用缩写。
在使用缩写时或之前,应对缩写进行必要阐明。
3.9注释位置
注释应与其描述代码相近,对代码注释应放在其上方或右方(对单条语句注释)相邻位置,不可放在下面,如放于上方则需与其上面代码用空行隔开。
例1:
/*getreplicatesubsystemindexandnetindicator*/
例2:
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注释缩排
注释与所描述内容进行同样缩排。
可使程序排版整洁,并以便注释阅读与理解。
如下例子,排版不整洁,阅读稍感不以便。
/*codeonecomments*/
CodeBlockOne
/*codetwocomments*/
CodeBlockTwo
应改为如下布局。
/*codeonecomments*/
3.14注释与代码之间空行
将注释与其上面代码用空行隔开。
如下例子,显得代码过于紧凑。
programcodeone
/*codetwocomments*/
programcodetwo
3.15变量定义、分支语句
对变量定义和分支语句(条件分支、循环语句等)必要编写注释。
这些语句往往是程序实现某一特定功能核心,对于维护人员来说,良好注释协助更好理解程序,有时甚至优于看设计文档。
示例(注意斜体加粗某些):
caseCMD_UP:
ProcessUp();
break;
caseCMD_DOWN:
ProcessDown();
caseCMD_FWD:
ProcessFwd();
if(...)
...
else
ProcessCFW_B();
//nowjumpintocaseCMD_A
caseCMD_A:
ProcessA();
caseCMD_B:
ProcessB();
caseCMD_C:
ProcessC();
caseCMD_D:
ProcessD();
...
3.16其她
3.16.1避免在一行代码或表达式中间插入注释。
除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。
3.16.2通过对函数或过程、变量、构造等对的命名以及合理地组织代码构造,使代码成为自注释。
清晰精确函数、变量等命名,可增长代码可读性,并减少不必要注释。
3.16.3在代码功能、意图层次上进行注释,提供有用、额外信息。
注释目是解释代码目、功能和采用办法,提供代码以外信息,协助读者理解代码,防止没必要重复注释信息。
如下注释意义不大。
/*ifreceive_flagisTRUE*/
if(receive_flag)
而如下注释则给出了额外有用信息。
/*ifmtpreceiveamessagefromlinks*/
3.16.4在程序块结束行右方加注释标记,以表白某程序块结束。
当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。
参见如下例子。
//programcode
while(index<
MAX_INDEX)
}/*endofwhile(index<
MAX_INDEX)*///指明该条while语句结束
}/*endofif(...)*///指明是哪条if语句结束
3.16.5注释格式尽量统一,建议使用“/*……*/”。
3.16.6注释应考虑程序易读及外观排版因素,使用语言若是中、英兼有,建议多使用中文,除非能用非常流利精确英文表达。
注释语言不统一,影响程序易读性和外观排版,出于对维护人员考虑,建议使
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 华为 代码 综合 规范 文档