系列导航

  1. Python 基础教程
  2. 在 SublimeEditor 中配置 Python 环境
  3. Python 代码中添加注释
  4. Python 中的变量的使用
  5. Python 中的数据类型
  6. Python 中的关键字
  7. Python 字符串操作
  8. Python 中的 list 操作
  9. Python 中的 Tuple 操作
  10. Pythonmax（）和 min（）–在列表或数组中查找最大值和最小值
  11. Python 找到最大的 N 个（前 N 个）或最小的 N 个项目
  12. Python 读写 CSV 文件
  13. Python 中使用 httplib2–HTTPGET 和 POST 示例
  14. Python 将 tuple 开箱为变量或参数
  15. Python 开箱 Tuple–太多值无法解压
  16. Pythonmultidict 示例–将单个键映射到字典中的多个值
  17. PythonOrderedDict–有序字典
  18. Python 字典交集–比较两个字典
  19. Python 优先级队列示例

Python 代码中的注释

在 Python（或任何其他编程语言）中，注释用于解释源代码。良好的注释描述了代码的意图与逻辑，有助于将来维护应用程序。

注释示例概览

以下代码展示了 Python 中注释的基本用法，包括单行注释与多行字符串形式的注释：

# prints 4
print(2 + 2)

print(2 + 3) # prints 5

"""
prints the sum of
two numbers which are 2 and 2
"""
print(2 + 2)

Python 中的注释类型

Python 支持编写简单的单行注释以及多行注释。

单行注释

简单的单行注释以井号（#）字符开头。Python 解释器在运行时会忽略 # 字符后编写的任何文本，并将其视为注释。

# This is a simple comment
print(2 + 2)

print(2 + 3) # prints 5

多行注释

Python 并没有专门用于多行注释的语法符号（如某些语言中的 /* */）。要实现多行注释，通常有以下两种方式：

  1. 连续的单行注释：编写多个以 # 开头的单行注释。推荐使用这种形式，因为它明确意图且不会产生额外的对象。

    # This statement
# prints the sum of
# two numbers which are 2 and 2
print(2 + 2)

  2. 未赋值的多行字符串字面量：利用三引号（""" 或 '''）包裹的多行字符串。由于 Python 会忽略未分配给任何变量的字符串字面量，因此它不会影响程序执行，常被用作多行注释或文档字符串（Docstring）。

    """
This statement
prints the sum of
two numbers which are 2 and 2
"""
print(2 + 2)

如果您有关于 Python 注释编写的疑问，欢迎留言交流。

学习愉快！