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

一.缩进与对齐:

1)大括号匹配纵列对齐。//实际执行时总想把大括号留在句尾，经提醒修正了几次。

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

我写switch的时候违反了，后来改过来了。抛出题目数量异常的时候也没有注意到缩进，后来都改过来了。

二.函数长度

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

三.空格

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

while(true) {}//实际写的时候经常会错，但是好在很快就被发现改过来了

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

3)参数之间的逗号后要加一空格。如：method1(int i1, int i2)//废除，IDE自动写成这个格式

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

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

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

四．变量/方法命名规范

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

1）使用2~4个字母加注释作为临时变量名，并添加注释说明其意义。//曾经用过Pascal风格的命名，后来嫌太长修改为这样。

2) 使用多个单词组合作为变量名时，使用Pascal命名法。

3）使用多个单词作为方法名时，不用下划线连接，并且采用Pascal命名法//曾经用过比较短的，但是后来觉得体现不出其意义，就改为此种命名法。

 五.注释规范

1)  使用“//”添加注释。//还有多行注释可以使用，不过添加多行注释不够优雅，所以选择使用此种注释方式。

2)  每个声明的变量都做注释，使用行尾注释。//在每行的开头注释会显得代码过长，臃肿，不方便，所以改成了使用行尾注释（修改了规范）

3)  如果因为某种原因使用了复杂艰涩的原理，为程序配备良好的文档和充分的注释。//给出了参考链接（读取命令行参数和逆波兰表达式的求值以及中缀表达式转逆波兰表达式），在代码中也有适量的注释。本来我不觉得注释很重要，经讨论研究，注释、文档写得好，可以方便后来人，所谓前人种树后人乘凉。

4)  避免注释的二义性。//由于二义性很难避免，所以废除。

5)  在每个函数的开始，提供标准的注释样本以指示函数的用途。//实际执行中，由于全部注释的工作量太大，我们只对关键的、以及含义不直观的函数进行注释。