第 8 课 · 阶段二 · 基础语法
注释与代码规范
代码写多了，你会感谢自己当初写下的注释。这一课学习注释的写法、Python 的缩进规则、命名规范与 PEP8 风格。
🎯 学完本课你将掌握
- 会用 # 写单行注释、用三引号写多行注释
- 理解缩进对 Python 的重要性
- 掌握变量/函数/类的命名规范
- 了解 PEP8 的几条核心约定
一、为什么要写注释
注释是写给人看的说明文字，解释器会直接忽略它们。三个月后回头读代码，注释就是你最好的向导；团队协作时，注释让别人秒懂你的意图。
二、单行注释：用 #
注释示例.py
1# 这是一条注释，解释器会忽略它2print("这行会被执行")34x = 10 # 行尾注释：在代码后面加注释，注意留两个空格三、多行注释：用三个引号
多行注释.py
1# 多行注释用三个引号（单双皆可），这里用三个单引号演示2'''3这是多行注释（实际是字符串，但没人接收它时相当于注释）4可以写很多行说明5比如解释这个模块是干什么用的6'''7print("程序继续执行")⚠️ 注意
多行注释本质是一个没有接收者的字符串，功能上等价于注释。写单行注释用 #，写文档说明用三引号即可。
四、缩进：Python 的灵魂
其他语言用大括号 {} 表示代码块，Python 用缩进。同一层代码必须缩进一致（通常 4 个空格），混用 Tab 和空格会直接报错。
缩进示例.py
1if 3 > 1:2 print("条件成立") # 这行必须缩进 4 个空格3 print("我也属于 if")4print("我不属于 if，回到顶格")五、命名规范
| 对象 | 规范 | 示例 |
|---|---|---|
| 变量/函数 | 小写字母 + 下划线 | user_name、get_total |
| 常量 | 全大写 + 下划线 | MAX_SIZE、PI |
| 类名 | 大驼峰 | StudentInfo |
| 模块名 | 小写 + 下划线 | my_tools.py |
六、PEP8 核心约定（先记住这几条）
- 缩进统一使用 4 个空格，不用 Tab。
- 每行代码尽量不超过 79 个字符。
- 运算符两边加空格：a + b 而不是 a+b。
- 逗号后加空格：f(1, 2) 而不是 f(1,2)。
- 函数之间空两行，类内部方法之间空一行。
七、常见错误与解决
常见错误与解决
| 错误现象 | 原因 / 解决方法 |
|---|---|
IndentationError: unexpected indent | 缩进不统一，检查是否混用了 Tab 和空格，编辑器右下角可切换。 |
IndentationError: expected an indented block | if/for 等语句后忘记缩进，下一行必须缩进 4 空格。 |
注释里的中文报错 | 极少数老版本解释器需要文件头加 # -*- coding: utf-8 -*-，Python3 默认 UTF-8 无需处理。 |
✍️ 小练习
新建 comment.py，写 3 条单行注释 + 1 段多行注释，再用 if 语句故意写错缩进一次，观察报错信息长什么样。
📌 本节小结
注释（# 和三引号）帮自己和别人读懂代码；缩进是 Python 语法的一部分，统一 4 空格；命名遵循“小写下划线”等规范。好习惯从第一课养成，后面写代码会越来越顺手。