程序员面试宝典第六讲编程习惯优质PPT.ppt
《程序员面试宝典第六讲编程习惯优质PPT.ppt》由会员分享,可在线阅读,更多相关《程序员面试宝典第六讲编程习惯优质PPT.ppt(99页珍藏版)》请在冰豆网上搜索。
较长的语句(:
较长的语句(80字符)要分成多行书写,长表达式要在低字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
要进行适当的缩进,使排版整齐,语句可读。
perm_count_msg.head.len=NO7_TO_STAT_PERM_COUNT_LEN+STAT_SIZE_PER_FRAM*sizeof(_UL);
act_task_tableframe_id*STAT_TASK_CHECK_NUMBER+index.occupied=stat_poiindex.occupied;
act_task_tabletaskno.duration_true_or_false=SYS_get_sccp_statistic_state(stat_item);
report_or_not_flag=(tasknoMAX_ACT_TASK_NUMBER)&
(n7stat_stat_item_valid(stat_item)&
(act_task_tabletaskno.result_data!
=0);
1-4:
循环、判断等语句中若有较长的表达:
循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作式要在低优先级操作符处划分新行,操作符放在新行之首。
符放在新行之首。
if(tasknomax_act_task_number)&
(n7stat_stat_item_valid(stat_item)./programcodefor(i=0,j=0;
(iBufferKeywordword_index.word_length)&
(jNewKeyword.word_length);
i+,j+)./programcodefor(i=0,j=0;
(ifirst_word_length)&
(j),后不应加空格。
),后不应加空格。
采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C+语言中括号已经是最清晰的标志了。
在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。
给操作符留空格时不要连续留两个以上空格。
(1)逗号、分号只在后面加空格。
inta,b,c;
(2)比较操作符,赋值操作符=、+=,算术操作符+、%,逻辑操作符&
、&
,位域操作符=MAX_TIME_VALUE)a=b+c;
a*=2;
a=b2;
(3)!
、+、-、&
(地址运算符)等单目操作符前后不加空格。
*p=a;
/内容操作*与内容之间flag=!
isEmpty;
/非操作!
与内容之间p=&
mem;
/地址操作&
与内容之间i+;
/“+”,“-”与内容之间(4)-、.前后不加空格。
p-id=pid;
/“-”指针前后不加空格(5)if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显。
if(a=b&
cd)一行程序以小于一行程序以小于80字符为宜,不要写得过字符为宜,不要写得过长。
长。
2注释注释2-1:
一般情况下,源程序有效注释量必须:
一般情况下,源程序有效注释量必须在在20以上。
以上。
注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。
2-2:
说明性文件(如头文件:
说明性文件(如头文件.h文件、文件、.inc文件、文件、.def文件、编译说明文件文件、编译说明文件.cfg等)等)头部应进行注释,注释必须列出:
版权说头部应进行注释,注释必须列出:
版权说明、版本号、生成日期、作者、内容、功明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
文件的注释中还应有函数功能简要说明。
下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/*Copyright(C),*-*,*.Filename:
/文件名Author:
Version:
Date:
/作者、版本及完成日期Description:
/用于详细说明此程序文件完成的主要功能,与其他模块/或函数的接口,输出值、取值范围、含义及参数间的控/制、顺序、独立或依赖等关系Others:
/其它内容的说明FunctionList:
/主要函数列表,每条记录应包括函数名及功能简要说明1.History:
/修改历史记录列表,每条修改记录应包括修改日期、修改/者及修改内容简述1.Date:
Author:
Modification:
2.*/2-3:
源文件头部应进行注释,列出:
版权:
版权说明、版本号、生成日期、作者、模块目说明、版本号、生成日期、作者、模块目的的/功能、主要函数及其功能、修改日志等。
功能、主要函数及其功能、修改日志等。
下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/*Copyright(C),*-*,*.FileName:
test.cppAuthor:
Description:
/模块描述Version:
/版本信息FunctionList:
/主要函数及其功能1.-History:
/历史修改记录David96/10/121.0buildthismoudle*/说明:
Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。
History是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。
2-4:
函数头部应进行注释,列出:
函数的:
函数的目的目的/功能、输入参数、输出参数、返回值、功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
调用关系(函数、表)等。
下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/*Function:
/函数名称Description:
/函数功能、性能等的描述Calls:
/被本函数调用的函数清单CalledBy:
/调用本函数的函数清单TableAccessed:
/被访问的表(此项仅对于牵扯到数据库操作的程序)TableUpdated:
/被修改的表(此项仅对于牵扯到数据库操作的程序)Input:
/输入参数说明,包括每个参数的作/用、取值说明及参数间关系。
Output:
/对输出参数的说明。
Return:
/函数返回值的说明Others:
/其它说明*/2-5:
边写代码边注释,修改代码同时修改:
边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
相应的注释,以保证注释与代码的一致性。
不再有用的注释要删除。
2-6:
注释的内容要清楚、明了,含义准确,:
注释的内容要清楚、明了,含义准确,防止注释二义性。
防止注释二义性。
错误的注释不但无益反而有害。
规则规则2-7:
避免在注释中使用缩写,特别是:
避免在注释中使用缩写,特别是非常用缩写。
非常用缩写。
在使用缩写时或之前,应对缩写进行必要的说明。
2-8:
注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对:
注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。
代码用空行隔开。
例1:
/*getreplicatesubsystemindexandnetindicator*/repssn_ind=ssn_dataindex.repssn_index;
例2:
repssn_ind=ssn_dataindex.repssn_index;
/*getreplicatesubsystemindexandnetindicator*/应如下书写/*getreplicatesubsystemindexandnetindicator*/repssn_ind=ssn_dataindex.repssn_index;
2-9:
对于所有有物理含义的变量、常量,如果其:
对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。
变量、常量、宏的注释应释,说明其物理含义。
变量、常量、宏的注释应放在其上方相邻位置或右方。
放在其上方相邻位置或右方。
/*activestatistictasknumber*/#defineMAX_ACT_TASK_NUMBER1000#defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/2-10:
数据结构声明:
数据结构声明(包括数组、结构、类、枚举等包括数组、结构、类、枚举等),如果,如果其命名不是充分自注释的,必须加以注释。
对数据结构的注其命名不是充分自注释的,必须加以注释。
对数据结构的注释应放在其上方相邻位置,不可放在下面;
对结构中的每个释应放在其上方相邻位置,不可放在下面;
对结构中的每个域的注释放在此域的右方。
域的注释放在此域的右方。
可按如下形式说明枚举/数据/联合结构。
/*sccpinterfacewithsccpuserprimitivemessagename*/enumSCCP_USER_PRIMITIVEN_UNITDATA_IND,/*sccpnotifysccpuserunitdatacome*/N_NOTICE_IND,/*sccpnotifyusertheNo.7networkcannot*/*transmissionthismessage*/N_UNITDATA_REQ,/*sccpusersunitdatatransmissionrequest*/;
2-11:
全局变量要有较详细的注释,包括对其功能、取值范围、:
全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
哪些函数或过程存取它以及存取时注意事项等的说明。
/*TheErrorCodewhenSCCPtranslate*/*GlobalTitlefailure,asfollows*/变量作用、含义/*0SUCCESS1GTTableerror*/*2GTerrorOthersnouse*/变量取值范围/*onlyfunctionSCCPTranslate()in*/*thismodualcanmodifyit,andother*/*modulecanvisititthroughcall*/*thefunctionGetGTT