编写Python代码时，始终使代码干净且易于理解始终是一个好习惯。
组织代码，给变量和函数提供描述性名称是实现此目的的几种方法。

提高代码可读性的另一种方法是使用注释。
注释是人类可读的解释或者注释，用于解释代码。
例如，如果我们编写了一个复杂的正则表达式，则会添加一条注释来描述代码的作用。

在将来查看代码时，在Python代码中添加注释将为我们节省大量时间和精力。
假设我们要更改几个月或者几年前编写的脚本。
除非我们添加注释，否则我们将不记得为什么编写了一些复杂的代码。
这些注释还可以帮助其他开发人员了解代码及其用途。

注释应该简短明了。
不要解释对读者显而易见的内容。

本文介绍了用Python编写注释的基础。

用Python编写注释

Python会忽略井号（'#'）之后写在该行上的所有内容。

注释可以添加到该行的开头，也可以与其他代码内联：

# This is a Python comment.
print("Hello World") # This is an inline Python comment.

井号后面的空格不是强制性的，但可以提高注释的可读性。

字符串文字中的井号字符并不表示注释行的开头。
它只是一个哈希字符：

paragraph = "# Hash inside quotes is not a comment."
Comments should be at the same indent level as the code beneath it:
``py
def factorial(n):
  if n == 0:
    return 1
  else:
    # Use the factorial function
    return n * factorial(n-1)

如果文本编辑器支持语法突出显示，则注释通常以绿色表示。

调试脚本时，注释也很有用。
除了删除一些行或者块，我们还可以将它们注释掉：

# for fruit in fruits:
#   print(fruit)

Python中的多行注释（注释块）

与其他流行的编程语言不同，Python仅支持单行注释。

用Python编写多行注释的最简单方法是一个接一个地添加单行注释：

# This is the first line.
# This is the second line.

另一种选择是使用docstrings。

文档字符串是多行字符串文字，用于记录模块，函数，类或者方法的功能。

一个文档字符串以三重双引号（'“”“'）开始和结束，并且可以跨越一行或者多行：

"""This is
a multiline
docstring.
"""

Docstrings从技术上讲不是注释。
当文档字符串作为模块，函数，类或者方法中的第一条语句出现时，它最终以字节码结 tail，并成为该对象的'doc'特殊属性。
我们应该更喜欢使用常规的单行哈希注释。

舍邦

如果我们正在阅读Python脚本，则可能会注意到其中一些第一行以“#！”开头。
字符和Python解释器的路径：

#!/usr/bin/env python3

此字符序列称为“ shebang”，用于告诉操作系统使用哪个解释器来解析文件的其余部分。

以shebang开头且可执行的脚本可以在终端中运行，而无需在脚本名称前键入“ python”。

由于shebang行以井号字符开头，因此它被视为注释，并被Python解释器自动忽略。