此作业要求参见:https://edu.cnblogs.com/campus/nenu/2019fall/homework/7630
结对伙伴:王可非
代码的规范
代码风格的原则是:简明,易读,无二义性。
(一)命名规范
1.函数名必须与题意和目的相关,体现意义,不能用简单字母(如a,b,c等)代替。
(二)格式规范
2.代码必须严格缩进,不仅仅用tab缩进,用4个空格缩进。
3.每行不超过字符不能超过80。
4.顶级定义之间空2行,方法定义(函数或类定义)之间空1行。
5.括号内不能留有空格。
6.在逗号、分号、冒号后面加空格。
7.“=”用于指示关键字参数或默认参数时不在两侧是用空格,作为算数操作符时在两边加一个空格。
8.如果一个类不继承自其他类,就从object集成,嵌套类同样遵循这一规则。
9.导入时每个导入占一行。
(三)注释规范
10.在函数后加简单注释说明其功能,且不能描述代码。为提高可读性,注释离开代码至少2个空格。
要求2 记录完成本周作业过程中,《代码风格规范》执行情况。
规范编号 纠正次数 原因 修改规范
其他应该注意的规范
(1).标识符应当直观且可以拼读,可望文知意,不必进行“解码”。
(2).标识符的长度应当符合“min-length && max-information”原则。
(3).命名规则尽量与所采用操作系统或开发工具的风格保持一致
(4).程序中不要出现仅靠大小写区分的相似的标识符。
(5).变量的名字应当使用“名词”或者“形容词+名词”
(6).局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。类的成员函数应当只使用“动词”,被省略掉的名词就是对象本身。
(7).用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
(8).用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
(9).变量和参数用小写字母开头的单词组合而成。
要求2 记录完成本周作业过程中,《代码风格规范》执行情况。