注释和文档

注释

注释是用于使代码更容易理解的代码的说明。它们不影响代码的运行。

在 Python 中，通过插入一个 ＃ 来创建注释。该行后面的所有文本都被忽略。

例如：

x = 365

y = 7

# 这是一个注释

print(x % y) # 打印余数

# print (x // y)

# 注释不会影响程序运行

结果：

1

注:Python 没有通用的多行注释。

---

文档

Docstrings和注释的目的类似，因为它们旨在解释代码。但是，它们更具体，并且具有不同的语法。

它们是通过在函数的第一行下面放置一个包含函数说明的多行字符串来创建的。

def shout(word):

  """

  给一个词后面加一个感叹号

  并打印这个词

  """

  print(word + "!")

shout("spam")

尝试一下

结果：

spam!

与传统的注释不同，文档字符串在整个程序运行时保留。这允许程序员在运行时检查这些文档注释。