注释

# 单行注释用井号,从这里到行尾都是注释
x = 42  # 行末注释也可以

"""
三引号字符串可以当多行注释用
(但严格来说它是字符串字面量)
"""

docstring:函数 / 类的文档

紧跟在 defclass 下面:

def add(a, b):
    """返回两个数的和。"""
    return a + b

help(add)    # 终端会打印 docstring

IDE 会读取 docstring 做悬浮提示。

缩进

Python 用缩进表示代码块——不像别的语言用 {}

if x > 0:
    print("正数")        # 这一行属于 if
    print("还在 if 里")
print("已经出 if 了")

永远用 4 个空格,不要用 Tab。VS Code / PyCharm 默认会自动转换。

PEP 8 关键规则

项目 推荐 反例
变量名 user_name userName
函数名 get_user getUser
常量 MAX_SIZE MaxSize
类名 UserAccount user_account
行长度 ≤ 79–99 字符 一行 200 字符 ❌
等号空格 x = 1 x=1 ❌(赋值时)
函数关键字参数 f(x=1) f(x = 1) ❌(这里没空格)
空行分隔 函数间空 2 行 函数贴在一起 ❌

自动化工具

不用手动记规则——交给工具:

pip install black ruff
black myfile.py     # 一键格式化
ruff check myfile.py # 检查风格 + 错误

下一篇进入数据结构——列表 List 入门