20200924-4 代码规范,结对要求

此作业要求参见:https://edu.cnblogs.com/campus/nenu/2020Fall/homework/11244
战友:徐灿灿

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

比如, 每个函数不超过5行,对于初学者是不切实际的; 大括号匹配纵列对齐,是切实可行的; 变量名易读,是不易检验的,变量名必须是名词短语,遵循熊匈牙利命名法,是易于检验的。 (10分)
代码规范分为两部分:代码风格规范和代码设计规范

(1)代码风格规范:

1.缩进
在缩进我们统一使用了四个空格来控制缩进,在此之前是我习惯使用Tab。当阅读了书籍后知道Tab键在不同环境下显示不同长度(这个问题在从编辑器里面将代码拷进博客时就发现了一直没有找到根本原因),然后决定使用四个空格来控制缩进。

2.行宽

编辑器的宽度是有限的,超出宽度后会对于代码的阅读带来极大的困难,根据书本建议我们限制长度为100字符

3.括号

简单的表达式逻辑清楚,当表达式足够复杂时对于代码的阅读也会增加困难,使用括号来对表达式的优先级做一个限制,会使表达式逻辑易读。

4.断行与空白的{}行

对于断行我们我们没有争议,在“{}”的使用中,我的习惯是偏向于将左括号放于表达式的结尾与书籍内容略有不同,两人商议后决定采用“{}”两个括号各占一行的规范。

5.分行

每一个语句都独占一行。

6.命名

变量的命名不能使用一些“m,n,i,j”等自己可以看懂别人看不懂的变量名称来表示,每一个变量名称必须包含自己所代表的意思。

7.下划线
下划线用来标志同一类变量

8.大小写

所有的类型/类/函数名都用第一个字母都大写;所有变量都用第一个单词全部小写,随后的单词使用Pascal形式

9.注释

注释尽量简洁,只需要标注出主要内容,如函数的作用,工作原理以及对于特殊的语句进行解释

(2)代码设计规范:

10.函数

将每一个功能作为一个单独的函数,且一个函数只做一个事情。

11.错误处理

对于可能发生错误的地方,如函数的返回值调用可能接收到一个错误的参数,可以使用判读语句来进行处理一些错误情况。

12.代码复审

检查代码是否符合上面的代码的风格规范和设计规范。

目的:找出代码的不规则地方也可以通过对代码的规范处理发现代码的逻辑错误。

要求2 记录完成本周作业过程中,《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。

posted @ 2020-10-07 15:05  松鼠and龙猫  阅读(112)  评论(0编辑  收藏  举报