第一天 第二章 编码规范

  1、编写规则

python采用PEP8作为编码规范,下面给出一些应该严格遵守的条目。

a. 每个import语句只导入一个模块,避免一次导入多个模块。如:import os,sys

# 推荐
import os
import sys

# 避免
import os,sys

b. 不要在行尾添加分号“;”,也不要用分号将两条语句放在同一行

# 避免
height = input('enter a height');weight = input('enter a weight');

# 避免
height = input('enter a height');
weight = input('enter a weight');

# 推荐
height = input('enter a height')
weight = input('enter a weight')

c. 每行不要超过80个字符,如果超过,建议用小括号“()”将多行内容隐式的连接起来。不推荐用反斜杠“\”连接

# 避免
s = "我一直以为我是一只蜗牛。我一直在爬,\
        也许还没有爬到金字塔的顶端。"

# 推荐
s = ("我一直以为我是一只蜗牛。我一直在爬,"
        "也许还没有爬到金字塔的顶端。")

    有两种情况除外:导入模块的语句过长和注释里的URL

d. 使用必要的空行增加代码的可读性。一般在顶级定义(如函数或类)之间空两行,而方法定义之间空一行,另外,用于分隔某些功能的位置也可以空一行。

e. 运算符两侧、函数参数之间、“,”两侧建议用空格进行分隔。

f. 避免在循环中使用“+”和“+=”运算符累加字符串。因为字符串是不可变的,这样做会创建不必要的临时对象。推荐将每个字符串加入列表,然后循环结束后用join()方法连接列表。

g. 适当的使用异常处理结构提高程序容错性,但不能过多依赖异常处理,适当的显式判断还是必要的。

 

  2、命名规范

a. 模块名尽量短小,并且全部使用小写字母,可以使用下划线分隔多个字母。如:game_register,bmiexponent。

b. 包名尽量短小,全部使用小写字母,不推荐使用下划线。如:com.zack,com.zack.good。

c. 类名采用单词首字母大写形式。如:ZackIsGood。

d. 模块内部的类采用下划线“_”+首字母大写。如:_ZackStudy。

e. 函数、类的属性和方法的命名规则同模块类似,也是全部使用小写字母,多个字母间用“_”分隔。

f. 常量命名时全部用大写字母,可以使用下划线。

g. 使用单下划线“_”开头的模块变量或函数是受保护的,在使用from xxx import *语句不能导入这些变量或函数。

h. 使用双下划线“_”开头的实例变量或方法时私有。的

posted @ 2020-08-14 00:16  Zack6688  阅读(95)  评论(0)    收藏  举报