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

软件开发规《试行版》《编程语言开发规》2004-6-31排版1-1:程序块要采用缩进风格编写,缩进的空格数为4个。要求:使用编辑器提供的tab设置功能,设置为4;绝对不允许使用4个空格字符1-2:不允许把多个短语句写在一行中,即一行只写一条语句。示例:如下例子不符合规。=0;=0;=0;=0;1-3:较长的语句(页宽>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。示例:=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=p_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));1-4:if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。示例:如下例子不符合规。if(pUserCR==null)return;应如下书写:if(pUserCR==null){return;}1-5:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。1-6:程序块的分界符(如大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。示例:如下例子不符合规。if(...){...//programcode}voidexample_fun(void){...//programcode}应如下书写。for(...){...//programcode}if(...){...//programcode}voidexample_fun(void){...//programcode} 2注释2-1:一般情况下,源程序有效注释量必须在20%以上。说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。2-2:文件头部应进行注释,注释必须列出:说明、版本号、生成日期、作者、容、功能、:建议所有文件使用该格式;java文件使用javadoc要求的格式/************************************************* Copyright(