软件工程第四次作业-1代码规范

Posted 米赫

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了软件工程第四次作业-1代码规范相关的知识,希望对你有一定的参考价值。

结对同学:姜珊

 

排版规范

1.在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格,例如:

(1) 逗号、分号只在后面加空格 printf("%d %d %d" , a, b, c);  

(2)比较操作符, 赋值操作符"="、 "+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格 

(3)"!"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格 

2. 函数体的开始,类的定义,结构的定义,if、for、do、while、switch及case语句中的程序都应采用缩进方式,大括号独占一行并且位于同一列,同时与引用它们的语句左对齐。

可理解性规范

1. 程序在必要的地方必须有注释,注释要准确、易懂、简洁。

2. 注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。

3. 维护代码时,要更新相应的注释,删除不再有用的注释。  保持代码、注释的一致性,避免产生误解。

4.变量命名约定  

前缀是可选项,以小写字母表示;  基本类型是必选项,以小写字母表示;  

变量名是必选项,可多个单词(或缩写)合在一起,每个单词首字母大写。

5.枚举和枚举成员的命名  

枚举名各单词的字母均为大写,单词间用下划线隔开。  

枚举成员的命名规则:单词的字母全部大写,各单词之间用下划线隔开;要求各成员的第一个单词相同.

6. 函数的命名  单词首字母为大写,其余每个单词首字母大写,单词之间不用下划线。

7. 对指针进行充分的注释说明,对其作用、含义、使用范围、注意事项等说明清楚。  

在对指针变量、特别是比较复杂的指针变量声明时,应对其含义、作用及使用范围进行注释说明,如有必要,还应说明其使用方法、注意事项等。

可维护性  

1. 在逻辑表达式中使用明确的逻辑判断。

2. 预编译条件不应分离完整的语句。

3. 宏所定义的多条表达式应放在大括号内。

4.使用宏时,不允许参数发生变化。

5. 函数和过程中关系较为紧密的代码尽可能相邻。

6.每个函数完成单一的功能,不设计多用途面面俱到的函数。  多功能集于一身的函数,很可能使函数的理解、测试、维护等变得困难。  使函数功能明确化,增加程序可读性,亦可方便维护、测试。  

程序正确性、效率  

1. 严禁使用未经初始化的变量。    

2. 防止操易混淆的字符拼写错误。

3. 使用无符号类型定义位域变量。

4. 避免函数中不必要语句,防止程序中的垃圾代码,预留代码应以注释的方式出现。

5.循环体内工作量最小化。  

应仔细考虑循环体内的语句是否可以放在循环体之外,使循环体内工作量最小,从而提高程序的时间效率。

 

执行情况:

 

以上是关于软件工程第四次作业-1代码规范的主要内容,如果未能解决你的问题,请参考以下文章

软件工程第四次作业——代码规范

软件工程第四次作业-1代码规范

第四次作业之代码规范

第四次作业

第四次作业

第四次作业