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

Posted 2020-10-10

一.缩进与对齐:

1)大括号匹配纵列对齐。

2)对于缩进，除了编译器提供的符号缩进之外，我们可以自己给自己一个规范(请少用或者不用 Tab)，比如每一块代码相较上一个代码块有 4 个空格的缩进。

二.函数长度

每个函数有效代码（不包括注释和空行）长度不要超过 70 行。//原定的函数最大长度为50 行，实际上我写了一个超过五十行的函数，所以修改了此条规范。

三.空格

1)括号和它里面的字符之间不要出现空格。括号不应该和它前边的参数留有空格，如：

while(true) {}

2)但是方法名和左括号之间不要有空格。

3)参数之间的逗号后要加一空格。如：method1(int i1, int i2)

4)for语句里的表达式之间要加一空格。如：for (expr1; expr2; expr3)

5)二元操作符和操作数之间要用空格隔开。如：i + c;

6)强制类型转换时，在类型和变量之间要加一空格。如：(int) i ;//此条实际执行时违反了几次，没有加空格，后来修改了有空格的版本。

四．变量/方法命名规范

1）不要使用前缀“@”作为变量名的一部分。

2) 使用多个单词组合作为变量名时，使用骆驼命名法，即第一个单词的首字母小写，其它单词的首字母大写。

3）使用多个单词作为方法名时，不用下划线连接，并且采用Pascal命名法

 五.注释规范

1)  使用“//”添加注释。

2)  每个声明的变量都做注释，使用行尾注释。

3)  如果因为某种原因使用了复杂艰涩的原理，为程序配备良好的文档和充分的注释。

4)  避免注释的二义性。

5)  在每个函数的开始，提供标准的注释样本以指示函数的用途、假设和限制。注释样本应该是解释它为什么存在和可以做什么的简短介绍，以及该函数版本信息。