20200924-4 代码规范,结对要求
此作业要求参见:[https://edu.cnblogs.com/campus/nenu/2020Fall/homework/11244]
结对对象:花名(朱航序)
要求1 《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。
1.花括号 {}
花括号的开始在代码块开始的行尾,闭合在和代码块同一缩进的行首。
2.空行
空行可以表达代码在语义上的分割,注释的作用范围,在代码中不能包含多个空行,在函数和函数之间使用一个空行。
- 连续两行的空行代表更大的语义分割。
- 方法之间用空行分割
- 域之间用空行分割
- 超过十行的代码如果还不用空行分割,就会增加阅读困难
3.缩进
使用TAB进行缩进,四个空格长度。
4.行宽
行宽度不超过130
5.注释
块级别注释:单行时用 //, 多行时用 /* .. */。
行内注释:行内注释用 // 写在行尾。
6.骆驼法则
Java中,除了包名,静态常量等特殊情况,大部分情况下标识符使用骆驼法则,即单词之间不使用特殊符号分割,而是通过首字母大写来分割。比如: SupplierName, addNewContract,而不是 supplier_name, add_new_contract。
7.类名
首字母大写,,比如 SupplierService, PaymentOrderAction;不要 supplierService, paymentOrderAction.
8.方法名
- 首字母小写,如 addOrder() 不要 AddOrder()
- 动词在前,如 addOrder(),不要orderAdd()
9.源文件编码
源文件使用utf-8编码。
10.空格的使用
- 表示分割时用一个空格
- 二元三元运算符两边用一个空格隔开
- 逗号语句后如不换行,紧跟一个空格
要求2 记录完成本周作业过程中,《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。在编码过程中完全未被违反的条款,说明过于宽松,或你们已经完全"本能"反应,不应作为条款,在本要求及要求1中不得分。此种情况,应补充一条新的条款。
规则序号 | 规范条款 | 违规次数 | 条款变更 |
---|---|---|---|
1 | 花括号 {} | 朱航序违规3次,已更正 | 增强 |
2 | 空行 | 夏柳青违规2次,朱航序违规1次,已更正 | 保持 |
3 | 缩进 | 朱航序违规3次,夏柳青违规1次,已更正 | 增强 |
4 | 行宽 | 朱航序违规1次,已更正 | 保持 |
5 | 注释 | 夏柳青违规4次,已更正 | 增强 |
6 | 骆驼法则 | 夏柳青违规4次,已更正 | 增强 |
7 | 类名 | 朱航序违规1次,已更正 | 减弱 |
8 | 方法名 | 朱航序违规2次,夏柳青违规1次,已更正 | 保持 |
9 | 源文件编码 | 夏柳青违规1次,已更正 | 减弱 |
10 | 空格的使用 | 夏柳青违规3次,朱航序违规2次,已更正 | 增强 |