Python 中如何写注释

当我们编写代码时，为了让其他人易于理解和阅读代码，或者为了让自己方便回忆代码的用途和思路，我们需要在代码中添加注释。在 Python 中，注释用 # 符号表示，可以有单行注释和多行注释两种方式。

单行注释

单行注释是用来解释一行代码的作用，其语法为在代码后面添加 # 符号。例如：

a = 1 # 定义变量a并赋值为1

在这个例子中，定义了一个变量 a 并将其赋值为1，同时在代码末尾添加了一个注释来解释这行代码的作用。

单行注释也可以在代码行内部添加，可以在一行代码的前面使用 # 符号来添加注释。如下所示：

print("Hello, World!") # 输出一行字符串

在这个例子中，字符串“Hello, World!”将被打印到屏幕上。在代码末尾添加了一个注释来解释这行代码的作用。

多行注释

多行注释用于解释一段代码的作用，或者用于添加当前代码文件的信息。在 Python 中，多行注释使用三个单引号（'''）或者三个双引号（"""）来表示。例如：

'''
这是一个多行注释的示例。
它可以用于解释一段代码的作用，
或者添加当前代码文件的信息。
'''

在这个例子中，使用单引号包裹了一段多行注释，其中包含了三行文本。

多行注释同样可以使用双引号来表示，例如：

"""
这也是一个多行注释的示例。
使用双引号来表示。
"""

在这个例子中，使用双引号包裹了一段多行注释，其中包含了两行文本。

在使用多行注释时，要注意所写内容必须在三个引号之间，不能有空格。如果需要添加空格，则可以在每行左侧添加 # 符号，或者在多行注释前面添加一个单行注释。

总之，注释是优秀代码编写的一部分，无论单行注释还是多行注释，都为编写者和读者带来了非常多的方便，也是 Python 开发中不可缺少的一部分。