此作业要求参见:https://edu.cnblogs.com/campus/nenu/2020Fall/homework/11244
结对小伙伴:史志腾
要求1 《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。
代码规范分为两部分:代码风格规范和代码设计规范
(1)代码风格规范:
1.缩进
4个空格,不用tab键,不用tab键的理由是Tab键在不同情况下显示不同长度。
2.行宽
行宽必须限制,可以限定100字符
3.括号
在复杂表达式中,用括号清楚地表示逻辑优先级。
4.断行与空白的{}行
每个{和}都占一行
5.分行
不要把多条语句放在一行
6.命名
命名要有含义,增加可读性
7.下划线
下划线用来分隔变量名字中的作用域标注和变量的语义
8.大小写
所有的类型/类/函数名都用第一个字母都大写;所有变量都用第一个单词全部小写
9.注释
注释不要有多余的,注释是为了解释程序做什么,为什么这样做,以及特别注意的地方。
(2)代码设计规范:
10.函数
关于函数最重要的原则:只做一件事,并且要做好。
11.错误处理
如果你认为某事可能会发生,这时写代码来处理可能发生的错误情况。
12.代码复审
看代码是否在代码规范的框架内正确地解决了问题
目的:找出代码的错误,发现逻辑错误,发现算法错误,发现潜在的错误,发现可能需要改进的地方。
要求2 记录完成本周作业过程中,《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。
条数 | 错误次数 | 违反举例 | 纠正次数 | 规范的执行情况 |
第1条 | 2次 | 中缀表达式中由于缩进不正确导致if和else的匹配错误 | 2次 | 增强,严格缩进后,if和else匹配正确 |
第2条 | 4次 | 函数每一行的行宽字符不符合 | 4次 | 保持不变 |
第3条 | 1次 | float()强制转换时错误 | 1次 | 增强,已更正 |
第4条 | 0次 | 0次 | 保持不变 | |
第5条 | 0次 | 0次 | 保持不变 | |
第6条 | 4次 | 中缀表达式 def Reverse(s): | 4次 | 增强,总是习惯性的毫无意义命名 |
第7条 | 0次 | 0次 | 保持不变 | |
第8条 | 6次 | def file(exp,result): | 6次 | 增强,总是习惯性的把函数定义为小写 |
第9条 | 5次 | 调试用例时设置的变量注释后多余未删除 | 5次 | 增强,删除多余的注释 |
第10条 | 0次 | 0次 | 保持不变 | |
第11条 | 2次 | 打开文件时应该增加文件打开失败的处理 | 2次 | 增强 |
第12条 | 3次 | 在处理带分数时所遇到的负带分数没有代码复审 | 3次 | 增强 |