程序设计规范报告.docxVIP

程序设计规范报告 学 院：信息科学与工程学院 专 业： 计算机科学与技术 班 级： 学 号： 学生姓名： 一、程序设计规范及其示例 相对独立的程序块之间、变量说明之后必须加空行。 示例：如下例子不符合规范： if (!valid_ni(ni)) {— ...// program code } repssn_ind=ssn_data[index].repssn_index; repssn_ni=ssn_data[index].ni; 应如下无写： if (!valid_ni(ni)) { ... // program code } repssn_ind=ssn_data[index].repssn_index; repssn_ni=ssn_data[index].ni; 不兄许把多不短语句写在一行中，即一行只写一条语句。 示例：如下例子不符合规范： rect.length=0; rect.width=0; 应如下书写： rect.length=0; rect.width=0; if、for、do、while、case、switch、default 等语句自占一行，且 if、for、 do、while等语句的执 行语句部分无论多少都要加括号{}。 示例：如下例子不符合规范： if (pUserCR==NULL) return; 应如下书写： if (pUserCR==NULL) { return; } 除非必要，不要用数字或较奇怪的字符来定义标识符。 示例：如下命名，使人产生疑惑： #define EXAMPLE_0_TEST_ #define EXAMPLE_1_TEST_ void set_sls00( BYTE sls ); 应改为插意义的单词命名： #define EXAMPLE_UNIT_TEST_ #define EXAMPLE_ASSERT_TEST_ void set_udt_msg_sls( BYTE sls ); 源程序中关系较为紧密的代码应尽可能相邻。 说明:便于程序阅读和查找。 示例：以下代码布局不太合理： rect.length=10; char_poi=str; rect.width=5; 若按如下形式书写，可能更活晰一些： rect.length=10; rect.width=5; // 矩形的长与宽关系较密切，放在一起。 char_poi=str; 冷多重循环中，应将最忙的循环放在最内层。 说明:减少CPU?入循环层的次数。 示例：如下代码效率不高： for(row=0;row100;row++) ( for(col=0;col5;col++) ( sum+=a[row][col]; } } 可以改为如下方式，以提高效率： for(col=0;col5;col++) ( for (row=0;row100;row++) ( sum+=a[row][col]; } } 将注释与其上面的代码用空行隔开。 示例J :如下例子，显得代码过于紧凑： /* code one comments */ program code one /* code two comments */ program code two 应如下书写： /* code one comments */ program code one /* code two comments */ program code two 注释与所描述内容进行同样的缩排，让程序排版整齐，并方便注释的阅读与理 解。 示例：如下例子，排版不整齐，阅读稍感不方便： void example_fun( void ) { — /* code one comments */ CodeBlock One; /* code two comments */ CodeBlock Two; } 应改为如下布局： void example_fun( void ) { /* code one comments */ CodeBlock One; /* code two comments */ CodeBlock Two; } 避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物 理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。 示例：如下的程序可读性差： if(Trunk[index].trunk_state==0) { Trunk[index].trunk_state=1; ...// program code } 应改为如下形式： #define TRUNK_IDLE 0 #define TRUNK_BUSY 1 if(Trunk[index].trunk_state==TRUNK_IDLE) { Trunk[index].trunk_state=