微信公众号-IT赶路人，专注分享与IT相关知识，关注我，一起升职加薪！

image.png

你有没有请过程序员解释他一年前写的代码？或者您有没有尝试过阅读您以前编写的代码？如果你必须从头开始重新分析每一行代码，那将是非常耗时和累人的！最好的办法就是加个伴儿。注释不仅仅是用来增加代码行数的，它还是让代码变得有意义的最好方式。这里有一个完整的指南来帮助您理解Python中的所有注释。

什么是注释？

一般说来，注释是一个人的想法的表达。在编程中，注释是程序员一致的声明，它描述了这段代码的含义。当您编写大型代码时，它们会变得非常有用。当你有一个100页左右的程序时，记住每个变量的名称是非常不人道的。因此，使用注释将使您或其他人阅读和修改代码变得非常容易。 注释非常重要，但您需要知道如何使用它们，这正是我们将在下面的主题中讨论的内容。

如何使用注释？

注释可以包含在任何位置，这意味着也可以内联。最好的做法是按照您处理代码的方式以及如何编写相关注释。

• 注释需简短且相关

• 它们将特定于包含它们的代码的含义

• 确保使用得体的语言，因为使用粗俗的语言是不道德的

• 不要注释不言自明的行

Python如何写注释？

Python中的注释以# 字符开头。但是，有时也可以使用文档字符串(用三重引号括起来的字符串)进行注释，本文将对此进行进一步描述。

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

Python中的注释以# 开头，正如您在上面的输出中看到的那样，在输出中没有COMMENT语句的情况下执行print语句。
如果您有多个注释行，则所有注释行都需要加上前缀

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

Python中的注释上面的输出显示，所有以# 字符为前缀的行在输出中都没有翻转。
接下来，让我们看看注释是如何解释的，以及为什么它们从不出现在输出中。
Python如何解释注释？当解释器在任何地方遇到# 符号时(除了在字符串内，因为字符串中的# 只表示# )，它会省略它后面出现的所有内容，直到该行的末尾。标记实际上告诉解释器停止读取它后面的任何内容。

注释类型

• 单行或

• 多行

  
  275.png

单行注释

它们可以出现在单独的行中，也可以内联到其他一些代码中。

#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)

Output:2

多行注释：

多行注释显示在多行中。所有要修改的行都要加一个# 前缀。如果您不这样做，您将会遇到错误。

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

返回其各自的输出。
您还可以使用非常好的快捷方式来注释多行。您只需按住Ctrl键并在想要包含# 字符的任何位置单击鼠标左键，然后只需键入一次# 即可。这将注释您引入光标的所有行。
如果要从多行中删除# ，可以执行相同的操作，只使用退格键一次，所有选定的# 字符都将被删除。
但是，当您注释文档时，这些多行注释看起来非常令人不快。下面的主题将向您介绍此问题的解决方案。

Docstring注释

Docstring实际上不是注释，但它们是Documentation String。这些文档字符串包含在三重引号内。它们没有分配给任何变量，因此有时也用于注释的目的。
它们尤其在需要加入一些与类或函数等相关的文档时使用。

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

示例：OUTPUT：2.0

如您所见，输出不包含文档字符串，因此，它在代码启动之前出现时被省略了。
但是，如果您只执行一个文档字符串，而不执行下面的代码，如上所述，输出将是字符串本身。

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

‘使用docstring作为注释。
此代码除以2个数字‘在上面的输出中，文档字符串已经打印出来，因为它后面没有任何代码。
现在，如果它在代码编写之后出现，那么在结果之后仍然会打印文档字符串。

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

2.0
'
Using docstring as a comment.
This code divides 2 numbers
'

如您所见，在输出之后打印了文档字符串。因此，如上所述，docstring在不同的位置表现不同，这取决于它在代码中出现的位置。这就把我们带到了本文的末尾。我希望您喜欢学习Python中的注释。

https://www.itxiaonv.com/?p=147

26322751-8bd00fde1a719aa1.jpg