作业20170928—1代码规范，结对要求

Posted 2020-10-09 袁玥

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

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

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

2.为避免代码长度过长需要断行造成难以阅读的问题，规定每行只写一条语句。

3.如何处理缩进问题？当遇到有关命名空间、类、结构、函数、以及枚举等等复杂程序结构的定义的时候，需要将它的内容缩进一层。

4.如何取变量名？规定变量名的取名原则是:变量名=属性+类型+对象描述，其中每一对象的名称都要求有明确含义，可以取对象名字全称或名字的一部分。

5.使用空行分隔代码块。

6.分行定义变量。

7.不能使用连续的两个或多个空格。

8.注释要写在函数的上方，注释不能跟代码写在同一行。

9.每个代码文件要有一个相对应的readme文档说明。

10.编程原则是先确定代码结构，写出框架再逐步分模块进行填充。

（这是我自己对于代码风格的初步设想，最终版需要跟partner一起敲定）

 

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