python中的注释

https://peps.python.org/pep-0008/#comments
PEP 257 – Docstring Conventions：https://peps.python.org/pep-0257/

块注释

• 块注释通常适用于跟在它后面的部分或者所有代码。
• 块注释跟它注释的代码保存同样的缩进。
• 块注释的每一行用一个#开头，然后是一个空格，然后是注释内容。
• 在块注释中，不同的段落之间用一行只包含一个#符号的行隔开。

例如：

# 打印简单的信息
# 下面的内容是为了演示的需要
print("hello python")

行内注释

• 很少使用行内注释。
• 行内注释和注释的代码在同一行，和代码之间至少用两个空格隔开，然后是# ，然后是一个空格，然后是注释内容。
  例如：

MAX_OVERFLOW = 100      # 定义最大溢出值

文档字符串注释

三对双引号””””””是文档字符串注释，例如：

"""这是文档字符串注释
可以分多行

"""
print("hello python")

• 如果文档字符串注释的内容包含多行，那么结束文档字符串注释的"""符号应该单独占一行。例如：

"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""

• 如果文档字符串注释的内容只有一行，那么结束文档字符串注释的"""符号在同一行，例如：

"""Return an ex-parrot."""

• 文档字符串注释出现在模块、函数、类、或者方法定义的前面
• 所有模块通常需要有文档字符串注释
• 被一个模块导出（export）的函数和类通常需要有文档字符串注释
• 公共的方法（包含__init__ 构造器）通常需要有文档字符串注释
• 文档字符串注释可以有多行。在这种情况下，第一行是摘要信息，然后是一行空行，然后是更具体的信息。摘要信息行可以跟左引号在同一行，或者在下一行。
• 整个文档字符串注释的缩进和第一行的引号相同。