PEP8 是 Python 社区广泛采用的编码规范,旨在提高代码的可读性和一致性。
1. 文件编码
Python 文件应该使用 UTF-8 编码,并在文件开头添加以下声明:
# coding: utf-8
2. 空格和缩进
- 使用 4 个空格进行缩进,而不是制表符。
- 在操作符前后添加空格,例如:
x = 1 + 2
。 - 在函数调用时,在括号内添加空格,例如:
print("Hello, world!")
。
3. 代码布局
- 每行代码不超过 79 个字符。
- 使用空行分隔函数和类定义。
- 在函数定义后添加两个空行。
4. 命名规范
- 变量和函数名使用小写字母,单词之间使用下划线分隔。
- 类名使用大写字母和下划线分隔。
- 常量名使用全大写字母,单词之间使用下划线分隔。
5. 注释
- 使用 # 符号进行单行注释。
- 使用三个双引号 ``` 进行多行注释。
6. 图片示例
下面是一个简单的 Python 函数示例:
def greet(name):
"""
打印问候语
"""
print(f"Hello, {name}!")
7. 扩展阅读
更多关于 PEP8 的信息,请访问PEP8 官方文档。
Python Logo