编程规范课程教材.docx
- 文档编号:9221361
- 上传时间:2023-02-03
- 格式:DOCX
- 页数:74
- 大小:54.59KB
编程规范课程教材.docx
《编程规范课程教材.docx》由会员分享,可在线阅读,更多相关《编程规范课程教材.docx(74页珍藏版)》请在冰豆网上搜索。
编程规范课程教材
内部资料,注意保密
编程规范教材
目录
前言软件编程规范总则3
第一章排版4
第二章注释11
第三章标识符命名19
第四章可读性22
第五章变量、结构25
第六章函数、过程33
第七章可测性43
第八章程序效率48
第九章质量保证53
第十章代码编辑、编译、审查60
第十一章代码测试、维护62
第十二章宏64
前言软件编程规范总则
为了提高源程序的质量和可维护性,最终提高公司软件产品生产力,我们有必要对公司软件产品的源程序的编写风格作出统一的规范约束。
本规范总则是独立于具体语言的编程规则的总的原则,针对不同编程语言或应用环境的编程规范在遵守本规范总则的基础上,还必须遵守相应语言和就用环境的编程规范。
本规范总则适用于公司所有产品以及对外合作委托开发产品的软件源程序。
本规范总则的内容包括:
排版、注释、标识符命名、变量使用、代码可测性、程序效率、质量保证、代码编译、单元测试、程序版本与维护等。
本规范总则的示例都以C语言为背景,采用以下的术语描述:
★规则:
编程时强制必须遵守的原则。
★建议:
编程时必须加以考虑的原则。
★说明:
对此规则或建议进行必要的解释。
★示例:
对此规则或建议从正、反两个方面给出例子。
第一章排版
¹1-1:
程序块要采用缩进风格编写,缩进的空格数为4个。
说明:
对于由开发工具自动生成的代码可以有不一致。
唯一例外的是编译开关和宏定义。
如下各举一个例子:
编译开关例子:
intSendMsg(EXEC_MSG*pMsg)
{
#ifdef_UNIT_DEBUG
DoTestFunc(pMsg);
#else
DoFunc(pMsg);
#endif
}
宏定义的例子:
intSendMsg(EXEC_MSG*pMsg)
{
#defineSET_MSG_HEAD\
if(pMsg)\
{\
SetMsgHead(pMsg);\
}\
else\
{\
SetMsgHeadZero();\
}
...//函数其它代码
}
¹1-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;
空行可以使程序结构比较清晰。
逻辑上关系比较紧密的代码放在一起,逻辑上相对比较独立的部分用空行隔开。
¹1-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)); 长语句分多行书写比较美观。 在低优先级操作符处划分新行,可使每一行具有相当独立而完整的含义,从而比较清晰。 折行时,操作符要放行首。 ¹1-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 } ¹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.length=0; rect.width=0; 不这样做一个很明显得缺点就是在调试的时候无法单步执行。 ¹1-7: if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。 示例: 如下例子不符合规范。 if(pUserCR==NULL)return; 应如下书写: if(pUserCR==NULL) { return; } 关键字独占一行是为了使程序结构清晰可读。 if、for、do、while等语句的执行语句部分无论多少都要加括号{},下面的例子来解释原因: 如果写成: if(pUserCR==NULL) return; 以后的测试中发现这种条件满足时,还要做一些其它处理,比如要写日志,那么很容易就写成了下面的语句: if(pUserCR==NULL) WriteLog('InvalidUserCR'); return; 写成这样就大错特错了,不管pUserCR是否为NULL,程序都会执行到return语句,造成逻辑错误。 为了避免这样的问题,因此要求if、for、do、while的执行语句,不管有多少,都要用{}括起来。 ¹1-8: 对齐只使用空格键,不使用TAB键。 说明: 以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐,不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键,因此使用BC合入的版本大多会将缩进变乱。 目前大多数的编程工具都提供奖TAB键和成空格键。 ¹1-9: 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。 对于case语句的缩进说明如下: 如果case语句中不需定义新的变量,则为: switch(pMsg->iMsgType) { caseEXEC_MSG: OnExecMsg(pMsg); break; ...//其它case处理语句 } 如果case语句中需要定义新的变量,则必须用{}括起来,缩进为: switch(pMsg->iMsgType) { caseEXEC_MSG: { DWORDdwDataLen=pMsg->dwMemLen-sizeof(MSG_HEAD); OnExecMsg(pMsg,dwDataLen); break; } caseSHAKE_HAND_MSG: ... } ¹1-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 } ¹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) ½1-1: 一行程序以小于80字符为宜,不要写得过长。 第二章注释 ¹2-1: 一般情况下,源程序有效注释量必须在20%以上。 说明: 注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 20%的标准要求不高,因为文件头部的注释,函数头部的注释就占了很大的比例。 因此达到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: Author: Modification: 2.... *************************************************/ 目前各种编辑器都提供宏的功能,通过宏功能可以方便的生成函数头,文件头的格式化注释。 ¹2-3: 源文件头部应进行注释,列出: 版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例: 下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /************************************************************ Copyright(C),1988-1999,HuaweiTech.Co.,Ltd. FileName: test.cpp Author: Version: Date: 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: 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。 不再有用的注释要删除。 实际编程过程中,代码与注释的书写关系有三种: 1)先写一行代码,然后马上写注释,也即边写代码边写注释 2)先写注释,再写代码 3)先把代码全写完了,再补注释。 第3)种方式是应该严格避免和禁止的。 第一种方式应用比较多,主要用与代码不是特别复杂的情况。 第二种方式主要用于代码结构非常复杂的情况,举例如下: shortExecSql(PARAM_LIST*pParamList,char*pUserName, char*pPasswd,intiExecFlag) { //先检查参数,看是否满足可执行Sql的五种条件 //准备分析Sql语句的全部环境和数据 //分析sql语句 //执行Sql语句,并盘点是否有结果集 //将执行结果打包返回 } 代码比较复杂时,先写注释,标识出程序的逻辑处理过程。 然后再对每一个逻辑处理过程进行语句书写。 这样程序写起来思路比较清晰,可读性也好。 ¹2-6: 注释的内容要清楚、明了,含义准确,防止注释二义性。 说明: 错误的注释不但无益反而有害。 注释的要点是准确,没有二意性。 把代码说清楚是目的。 ¹规则2-7: 避免在注释中使用缩写,特别是非常用缩写。 说明: 在使用缩写时或之前,应对缩写进行必要的说明。 ¹2-8: 注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。 示例: 如下例子不符合规范。 例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; ¹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: 注释与所描述内容进行同样的缩排。 说明: 可使程序排版整齐,并方便注释的阅读与理解。 示例: 如下例子,排版不整齐,阅读稍感不方便。 voidexample_fun(void) { /*codeonecomments*/ CodeBlockOne /*codetwocomments*/ CodeBlockTwo } 应改为如下布局。 voidexample_fun(void) { /*codeonecomments*/ CodeBlockOne /*codetwocomments*/ CodeBlockTwo } ¹2-13: 将注释与其上面的代码用空行隔开。 示例: 如下例子,显得代码过于紧凑。 /*codeonecomments*/ programcodeone /*codetwocomments*/ programcodetwo 应如下书写 /*codeonecomments*/ programcodeone /*codetwocomments*/ programcodetwo ¹2-14: 对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。 说明: 这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 编程 规范 课程 教材