欢迎来到天天文库
浏览记录
ID:43588453
大小:143.19 KB
页数:10页
时间:2019-10-11
《c代码编码规范_计算机软件及应用_IT计算机_专业资料》由会员上传分享,免费在线阅读,更多相关内容在工程资料-天天文库。
1、一、排版与注释1.1强制(强制)函数有效代码的规模尽量限制在100行以内(强制)腿圾、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。不允许把多个短语句写在一行中,即一行只写一条语句。若函数或过程中的参数较长,则要进行适当的划分。C弼制丿函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。(弼妙程序块的分界符(如C/C++语言的大括号'{'和'}')应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的
2、定义以及if、for、do、while、switchcase语句中的程序都要采用如上的缩进方式。(瞬9边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。(弼制丿注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面。[例1://getreplicatesubsystemindexandnetindicatorIrepssn_ind=ssn_data[index].repssn_index;
3、repssn_ni=ssn_data[index].ni;例2:repssn_ind=ssn_data[in
4、dex].repssn_index;
5、repssn_ni二ssn_data[index]・ni;//getreplicatesubsystemindexandnetindicator应如下书写//getreplicatesubsystemindexandnetindicatorIrepssn_ind=ssn_data[index].repssn_index;Irepssnni=ssndata[index].ni;“(强制)所有成员函数的实现不要放在class声明中,即使函数体为空(强制)每个空的循环体都需要给出确认性注释提示自己和别人,这个空循环确实是有意为之,并不是遗漏语句而导致
6、的;这样做提高了程序的可读性和可维护性。(强制)每个文件都必须有说明性注释、函数头部应该进行注释。5文件头统一注释格式:〃作者I〃版权〃功能//H期i//(其他需要的说明或备注)函数头统一注释格式:I〃功能I〃参数〃返回值〃说明//todo(选择性)1.2重要(重要)if、for、do、while^case>switch>default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。懂要丿对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。说明:这些语句往往是程序实现某一特定功能的关键,对于维护人员来说,良好的注解帮助I更好的理解
7、程序,有时其至优于看设计文档“I懂卸对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。示例://activestatistictasknumber#defineMAX_ACT_TASK_NUMBER1000#defineMAX_ACT_TASK_NUMBER1000//activestatistictasknumber懂劲注释的内容要清楚、明了,含义准确,防止注释二义性。亦1:错谋的注释不但无益反而有害。懂要丿修改代码时需要添加注释,并且表名修改的开始位置和结束位置以及相关日期等信息,
8、要注意嵌套问题,需要及时修改已存在的注释懂要丿数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。//seepinterfacewithseepuserprimitivemessagenameenumSCCP_USER_PRIMITIVE{N_UNITDA"TA_IND,//seepnotifyseepuserunitdatacomeN_NOTICE_IND,//seepnotifyusertheNo.7networkcannot//transmissiont
9、hismessageN_UNITDATA_REQ,//seepuser'sunitdatatransmissionrequest};"逢卸全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。1.3推荐鏗荐丿对于SW让ch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。鏗荐7丿通过对函数或过程、变量、结构等正确的命名以及合理
此文档下载收益归作者所有