[开发规范]编码排版、注释规范.doc

《[开发规范]编码排版、注释规范.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、软件开发规《试行版》Version1.0《编程语言开发规》2004-6-31排版¹1-1：程序块要采用缩进风格编写，缩进的空格数为4个。要求：使用编辑器提供的tab设置功能，设置为4；绝对不允许使用4个空格字符¹1-2：不允许把多个短语句写在一行中，即一行只写一条语句。示例：如下例子不符合规。rect.length=0;rect.width=0;应如下书写rect.length=0;rect.width=0;¹1-3：较长的语句（页宽>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整

2、齐，语句可读。示例：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_f

3、lag=((taskno

4、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。¹1-6：程序块的分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。示例：如下例子不符合规。if(...){...//programcode}voidexample_fun(void){...//programcode}应如下书写。for(...){...//programcode}if(

5、...){...//programcode}voidexample_fun(void){...//programcode}2注释¹2-1：一般情况下，源程序有效注释量必须在20％以上。说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。¹2-2：文件头部应进行注释，注释必须列出：说明、版本号、生成日期、作者、容、功能、修改日志等.示例：建议所有文件使用该格式；java文件使用javadoc要求的格式/***********************************************

6、**Copyright(C),1988-1999,YOEEInfoTech.Co.,Ltd.Filename://文件名Author:Version:Date://作者、版本及完成日期Description://用于详细说明此程序文件完成的主要功能，与其他模块//或函数的接口，输出值、取值围、含义及参数间的控//制、顺序、独立或依赖等关系Others://其它容的说明History://修改历史记录列表，每条修改记录应包括修改日期、修改//者及修改容简述#DateAuthorModification12***************************

7、**********************/¹2-3：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。示例：建议所有文件使用该格式；java文件使用javadoc要求的格式/*************************************************Description://函数功能、性能等的描述Pre-Conditions：//前置条件Param://输入参数说明，包括每个参数的作用、取值说明及参数间关系。Return://函数返回值的说明Others://其它说明********

8、*********************************