Python中的注释是什么以及如何使用它们？

您是否曾经要求任何程序员解释他一年前编写的代码？还是您曾经尝试阅读自己以前编写的代码？如果您必须从头开始重新分析每个代码块，这将变得非常耗时且累人！最好的办法是添加评论。注释不仅仅是增加代码行数，而且是使代码有意义的最佳方法。这是一个完整的指南，可以帮助您了解有关Python中注释的所有信息。

在继续之前，让我们只是有一个快速通过所有具有主题步行过海湾红这篇文章中- 

• What are Comments?
• How to make use of Comments?
• How does Python interpret Comments?
• Types of comments:
  1. Single-line
  2. Multi-line
• Docstrings Comments

什么是注释？

一般来说，评论是一个人思想的表达。在编程中，注释是程序员一致的语句，它们描述代码块的含义。当您编写大型代码时，它们将非常有用。当拥有一个一百页左右的程序时，记住每个变量的名称实际上是不人道的。因此，使用注释将使您或其他人很容易阅读和修改代码。

注释非常重要，但是您将需要知道如何使用它们，这正是以下主题中讨论的内容。 

如何使用注释？

注释可以包含在任何位置，这也意味着内联。最佳实践是在编写代码以及编写代码的方式中编写相关注释。  

 以下是一些在注释代码时将为您提供帮助的关键点：

• 评论必须简短且相关
• 它们是特定于所包含的代码块的
• 确保使用体面的语言，因为使用粗言秽语是不道德的
• 不要评论不言自明的台词

现在您已经知道注释的重要性，让我们继续前进，看看如何用Python编写注释。

如何用Python编写注释？

Python中的注释以＃字符开头。但是，有时也可以使用docstrings（用三引号引起来的字符串）进行注释，本文将对此进行进一步描述。

例：

#Comments in Python start like this
print("Comments in Python start with a #")

输出： Python中的注释以＃开头

如您在上面的输出中看到的，执行了print语句，而在输出中不存在comment语句。

 如果您有多个注释行，则所有注释行都必须以＃开头。

例：

#Comments in Python
#start with this character
print("Comments in Python")

输出： Python注释

上面的输出显示在输出中未返回所有以＃字符为前缀的行。

继续前进，让我们看一下注释的解释方式以及为什么它们永远不会出现在输出中。

Python如何解释注释？

当解释器在任何地方遇到＃符号时（字符串内部除外，因为字符串中的＃只是表示＃），它会忽略出现在该行末尾的所有内容。＃标记实际上告诉解释器停止读取之后的所有内容。

评论类型

注释可以是

• 单行或
• 多行

单行注释：

它们可以显示在单独的行中，也可以与其他一些代码内联。

例：

#multiplying two variables          (this line starts with a #, hence will be ignored till line ends)
a=1
b=2
c=a*b
print(c)     # printing result      (inline comment, whatever is present after # will be ignored)

输出：2

多行注释：

多行注释出现在多行中。所有要注释的行都以＃开头。如果不这样做，将会遇到错误。

例：

#adding 2 variables
#pinting the result in a new variable
a=2
b=3
c=a+b
print(c)

输出：5

上面的输出表明，省略了以＃字符为前缀的前两个程序行，并执行了程序的其余部分，并返回了它们各自的输出。

您也可以使用非常好的快捷方式注释多行。您需要做的就是按住ctrl键，并在要包含＃个字符的任何地方单击鼠标左键，然后只键入一次＃。这将注释您引入光标的所有行。

如果要从多行中删除＃，则可以执行相同的操作，并仅使用一次Backspace键，所有选择的＃个字符都将被删除。

但是，在注释文档时，这些多行注释看起来非常不愉快。以下主题将向您介绍此问题的解决方案。

Docstring注释：

Docstrings实际上不是注释，而是文档字符串。这些文档字符串用三引号引起来。它们没有分配任何变量，因此有时也可以用作注释的目的。

当您需要关联与类或函数等有关的一些文档时，尤其可以使用它们。

例：

"""
Using docstring as a comment.
This code divides 2 numbers
"""
x=8
y=4
z=x/y
print(z)

输出：2.0

如您所见，输出不包含docstring，因此，它已被省略，因为它在代码启动之前就已出现。

但是，如果仅执行一个不带以下代码的文档字符串，如上所示，则输出将是字符串本身。

例：

"""
Using docstring as a comment.
This code divides 2 numbers
"""

输出："

使用文档字符串作为注释。
该代码将2个数字相除

"

在上面的输出中，该文档字符串已经打印，因为它后面没有任何代码。

现在，如果在编写代码后它仍然存在，则在结果之后仍将打印文档字符串。

例：

x=8
y=4
z=x/y
print(z)
"""
Using docstring as a comment.
This code divides 2 numbers
"""

输出：

2.0

“

使用文档字符串作为注释。

该代码将2个数字相除

”

如您所见，文档字符串已在输出之后打印出来。因此，因此，如上所述，docstring在不同位置的行为取决于在代码中出现的位置。这使我们到了本文的结尾。希望您喜欢在Python中学习注释。确保尽可能多地练习并恢复经验。