20180925-5 代码规范,结对要求

20180925-5 代码规范,结对要求

作业要求:https://edu.cnblogs.com/campus/nenu/2018fall/homework/2147

要求1 《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。

比如, 每个函数不超过5行,对于初学者是不切实际的; 大括号匹配纵列对齐,是切实可行的; 变量名易读,是不易检验的,变量名必须是名词短语,遵循熊匈牙利命名法,是易于检验的。 

要求2 记录完成本周作业过程中,《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。在编码过程中完全未被违反的条款,说明过于宽松,或你们已经完全"本能"反应,不应作为条款,在本要求及要求1中不得分。此种情况,应补充一条新的条款。

我们这次作业使用Java编写,所以对Java的语法规则进行代码规范。

1. 划分出新行要进行适应的缩进,使排版整齐,语句可读。

2.尽量使用完整的英文的英文描述符

3.采用大小写混合使名字可读

4.避免使用长的名字(小于十个字母)

5.避免使用类似的名字,或仅仅大小写不同的名字

6.参数的命名必须与变量的命名规范一致

7.单行注释之前应该也有一个空行。

8.若为可以显示在一行内短注释,要与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完,就该采用块注释的方式。

9.行长度要尽量去避免一行长度超过80个字符,很多终端和工具不能很好的处理。

10.相对独立的程序块与块之间加空行。

违反规范

违规次数

原因

1

13

不自觉的就会默认缩进方式

2

7

有些单词不记得拼错

3

3

有时默认小写忘记规范

4

0

很少起长名

5

1

6

5

7

15

经常忘记

8

0

9

0

10

2

 

 

原文地址:https://www.cnblogs.com/fjingxuan/p/9755993.html