位军营 20190919-5 代码规范,结对要求

本次作业要求参见:[https://edu.cnblogs.com/campus/nenu/2019fall/homework/7630]

结对伙伴:迟俊文

使用语言:Python

 

参考网站网址:

http://www.runoob.com/w3cnote/google-python-styleguide.html

 

要求1 《代码规范》包括10项条款

1.缩进

不要tab和空格混用,python与C/C++等语言的不同之一在于它是通过识别代码的缩进来识别程序的逻辑的,可能也因此python不支持tab和空格混用进行代码缩进,初用python的我们在这一点上吃了不少苦头,起初一直在埋怨python不让我们加代码,“太笨了”,解决之后发现自己“太笨了”,有点像是工作中的“甲方”,明明自己笨,还埋怨乙方的东西不好。

2.函数命名

2.行长度

注释除外,每行不超过80个字符,否则有可能导致一行过长而不易于程序阅读。Python会将圆括号,中括号和花括号中的行隐式的连接起来,如果需要,我们可以利用这个特点,可以在表达式外围增加一对额外的圆括号。

3.注释

在注释中,如果必要,将长的URL放在一行上,易于阅读。

4.空行

顶级定义之间空两行,比如函数或者类定义,方法定义,类定义与第一个方法之间,都应该空一行。函数或方法中,某些地方要是你觉得合适,就空一行。

5.空格

不要在逗号,分号,冒号前面加空格,但应该在它们后面加(除了在行尾)。在二元操作符两边都加上一个空格,比如赋值(=),比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not)。

6.导入格式

每个导入应该独占一行,

导入总应该放在文件顶部,位于模块注释和文档字符串之后,模块全局变量和常量之前.。导入应该按照从最通用到最不通用的顺序分组:

  1. 标准库导入
  2. 第三方库导入
  3. 应用程序指定导入

每种分组中,应该根据每个模块的完整包路径按字典序排序,忽略大小写。

7.语句

通常每个语句应该独占一行,不过,如果测试结果与测试语句在一行放得下,你也可以将它们放在同一行。如果是if语句,只有在没有else时才能这样做。

8.命名避免

  1. 单字符名称,除了计数器和迭代器。
  2. 包/模块名中的连字符(-)。
  3. 双下划线开头并结尾的名称(Python保留,例如__init__)。

9.命名约定

  1. 表意清晰,方便日后阅读
  2. 变量名首字母不大些
  3. 函数名首字母大写
  4. 使用下划线连接两个单词
  5. 函数传参简洁,不做限制

10.访问控制

在Python中,对于琐碎又不太重要的访问函数,你应该直接使用公有变量来取代它们,这样可以避免额外的函数调用开销。当添加更多功能时,你可以用属性来保持语法的一致性。

 

要求2 记录完成本周作业过程中,《代码风格规范》执行情况。

 

 

posted @ 2019-09-25 14:55  位军营  阅读(141)  评论(0编辑  收藏  举报