韩昊 20190919-5 代码规范,结对
本次作业要求参见:[https://edu.cnblogs.com/campus/nenu/2019fall/homework/7630]
结对伙伴:刘信鹏
要求1 《代码规范》包括10项条款。
1、分号
不要在行尾加分号,也不要用分号将两条命令放在同一行。
2、行长度
每行不超过80个字符,以下情况除外:
a.长的导入模块语句
b.注释里的URL
不要使用反斜杠连接行。
3、缩进
用4个空格来缩进代码,绝对不要用tab,也不要tab和空格混用.。
对于行连接的情况, 你应该要么垂直对齐换行的元素(第一行有参数), 或者使用4空格的悬挂式缩进(第一行无参数):
Yes: # 与起始变量对齐 foo = long_function_name(var_one, var_two, var_three, var_four) # 4 个空格缩进,第一行不需要 foo = long_function_name( var_one, var_two, var_three, var_four)
4、注释
a.块注释
“#”号后空一格,段落间用空行分开(同样需要“#”号)
b.行注释
至少使用两个空格和语句分开,注意不要使用无意义的注释
# 正确的写法
x = x + 1 # 这里使用两个空格和语句分开
5、特殊运算符
任何二目、三目运算符的左右两边都需要加一个空格
6、类名
类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头;将相关的类和顶级函数放在同一个模块里,不像Java,,没必要限制一个类一个模块。
[注]引用百度百科关于驼峰(CamelCase)命名风格的解释:
https://baike.baidu.com/item/%E9%AA%86%E9%A9%BC%E5%91%BD%E5%90%8D%E6%B3%95/7794053?fr=aladdin
7、函数
函数名一律小写,如有多个单词,用下划线隔开;私有函数在函数前加一个下划线_
8、变量名
变量名尽量小写, 如有多个单词,用下划线隔开
9、参数
方法参数在定义和传入时,多个参数逗号后边必须加空格
10、语句
通常每个语句应该独占一行,不过,如果测试结果与测试语句在一行放得下,你也可以将它们放在同一行。如果是if语句,只有在没有else时才能这样做。特别地,绝不要对 try/except 这样做,因为try和except不能放在同一行。
[注]此代码规范参考博客:
https://www.jianshu.com/p/5ea95e6cf8e4
https://www.runoob.com/w3cnote/google-python-styleguide.html
要求2 记录完成本周作业过程中,《代码风格规范》执行情况。