如何用Python注释

编写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.
"""

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

Shebang

如果您正在阅读Python脚本，您可能会注意到其中的第一行以#!字符和Python解释器的路径开头：

#!/usr/bin/env python3

此字符序列称为 shebang ，用于告诉操作系统使用哪个解释器来解析文件的其余部分。 以shebang开头且可执行的脚本可以在终端中运行，而无需在脚本名称前键入python。

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

结论

编写注释是一个好习惯，它可以帮助其他开发人员（包括将来的自己）理解代码的作用。 在Python中，井号（#）之后直到行尾的所有内容都被视为注释。

如果您有任何问题或反馈，请随时发表评论。