python编码规范
本文档给出了Python主要发行版中包含标准库的Python代码的编码约定。请参阅有关Python[1]的C实现中的C代码的描述样式指南的配套信息PEP。
本文档和PEP 257(文档字符串约定)改编自Guido的原始Python风格指南文章,并添加了一些Barry的风格指南[2]。
这种风格指南随着时间的推移而发展,因为语言本身的变化确定了更多的约定,而过去的约定也变得过时了。
许多项目都有自己的编码风格指南。在发生任何冲突时,此类特定于项目的指南应优先用于该项目。
那么,本文是简单介绍PEP 8和PEP 257介绍。
pep8规范
格式化pep8快捷键:ctrl+alt+L
1、缩进
#每一级缩进4个空格(pycharm里是一个tab)
#对齐缩进:参数对齐左边括号
#悬挂缩进:4个空格,对齐参数
#层级缩进:8个空格,对齐参数
2、行的最大长度
#单行代码字符数不要超过79个字符
#通过“\”来隐式换行
#注释最大72字符
with open(r"D:\360downloads\wpcache\p3.qhimg.com\bdr\__85\file01") as file01, \
open(r"D:\360downloads\wpcache\p3.qhimg.com\bdr\__85\file02") as file02:
content=file01.read()
file02.write(content)
3、空行
#顶层函数和类定义,前后用两个空行隔开
#类里的方法定义用一个空行隔开
4、注释
#写代码前先写注释,修改代码也应该先修改注释
def func(n1, n2, n3 ):
"""自定义函数
:n1:参数1
:n1:参数2
:n1:参数3
:return:返回结果
"""
5、命名约定
#禁止使用I(小写的L)、O(大写的o)、l(大写的i)
6、字符串引号
7、模块和包导入规范
#模块导入顺序:官方库-》第三方库-》自定义模块
#__all__变量:限制导入可以使用这种方法
pep257规范
1、工程结构化
#项目名称,即项目文件夹