今天睡了20多个小时,很疲惫,不过还好学习的内容不是代码相关的,更像是代码行为规范守则
知识点实在是太零散了,全是概念,口头约定,我就搜索了一些文档,做一下总结
py的缩进和规范,可以让编程者养成良好的习惯
1. 缩进规则
Python 使用缩进来表示代码块的层级关系,而不是使用大括号 {}
。正确的缩进是 Python 程序正常运行的关键。
- 标准缩进:每个代码块使用4个空格进行缩进。
- 禁止使用制表符 (Tab):要统一使用空格或制表符。
- 混合缩进:不要混合使用空格和制表符。
示例
def my_function():
x = 10 # 4个空格缩进
if x > 5:
print("x is greater than 5") # 再次缩进
2. PEP 8 - Python 编码规范
PEP 8 是 Python 的官方编码风格指南,以下是一些关键规范:
2.1 命名约定
- 函数名:使用小写字母,单词之间用下划线分隔 (
snake_case
)。 - 类名:使用驼峰命名法,首字母大写 (
CamelCase
)。 - 常量名:使用全大写字母,单词之间用下划线分隔 (
UPPER_CASE
).
2.2 空行
- 类和函数定义之间应至少有两行空行。
- 方法内部的代码块之间可以用一行空行分隔。
2.3 空格使用
- 操作符两边应有一个空格,但不要在圆括号内多余地加空格。
示例:
a = 1 + 2 # 操作符两边加空格
def func(arg1, arg2): # 圆括号内部不加空格
pass
2.4 注释
- 单行注释应当使用
#
,并且至少留一个空格。 - 多行注释使用文档字符串或
#
进行逐行注释。
3. 文档字符串 (Docstrings)
文档字符串用于描述模块、类和函数的功能。文档字符串应当简洁明了,提供必要的说明。
示例:
def add(a, b):
"""
这是一个加法函数,返回 a 和 b 的和。
"""
return a + b
参考链接
PEP 8 - Python官方编码风格指南
Python官方文档
16 代码缩进_哔哩哔哩_bilibili
17 代码规范_哔哩哔哩_bilibili