20200924-4 代码规范,结对要求
作业要求参见:https://edu.cnblogs.com/campus/nenu/2020Fall/homework/11244
结对对象:蒋慧
结对要求,适用于本周所有标注"结对"的作业:
-
每2人自愿结成1对,代码规范、单元测试、四则运算试题生成,均由此2人共同完成。
-
要求此2人单元测试和四则运算试题生成编码,可以远程。
-
此前(以当前发布为准,第一次作业)累积成绩前10%的同学,禁止彼此结对。
参见教材第68页至第78页,2人结对编写《代码规范》,并在本周作业中遵循。
要求1 《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。
比如, 每个函数不超过5行,对于初学者是不切实际的; 大括号匹配纵列对齐,是切实可行的; 变量名易读,是不易检验的,变量名必须是名词短语,遵循匈牙利命名法,是易于检验的。 (10分)
《代码规范》
十项条款:
1.缩进
4个空格;不使用Tab键,因为Tab键在不同情况下显示不同长度。
2.行宽
行宽限制为100字符。
3.括号
在复杂的条件表达式中,需用括号清楚地表示逻辑优先级;括号需保证匹配,成对出现,不可缺少。
4.注释
去掉多余注释(如程序是怎么工作的);“#”后空一格;复杂注释放在函数头。
5.命名
命名需有意义,易读,辅助理解功能作用;避免过多描述。
6.分行
不要把多条语句或多个变量定义放在一行上。
7.大小写
多个单词组成的变量名,不可全部小写,可用大小写区分,采用Camel形式。
8.下划线(废除)
分隔变量名字中的作用域标注和变量的语义。
9.导入包
只导入使用过的包,删除多余包。
10.逗号
逗号之后要加一个空格。
11.空行(新增)
导入的包和函数之间空一行,定义的函数之间空一行。
要求2 记录完成本周作业过程中,《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。在编码过程中完全未被违反的条款,说明过于宽松,或你们已经完全"本能"反应,不应作为条款,在本要求及要求1中不得分。此种情况,应补充一条新的条款。 (20分)