📜  Python 多行注释 - Python (1)

📅  最后修改于: 2023-12-03 15:19:08.547000             🧑  作者: Mango

Python 多行注释

在 Python 中,多行注释使用三个连续的单引号( ''' )或三个连续的双引号( """ )表示。

多行注释可以跨越多行,用于向代码添加文档或注释,但是它们不会被解释器执行。

以下是一个使用三个双引号的例子:

"""
这是一个多行注释。
它可以跨越多行。
多行注释用于向代码添加文档或注释。
但是它们不会被解释器执行。
"""

以下是一个使用三个单引号的例子:

'''
这是另一个多行注释。
它可以跨越多行。
多行注释用于向代码添加文档或注释。
但是它们不会被解释器执行。
'''

请注意,在第一个例子中,注释以三个双引号开头和结尾,并以单引号括起字符串;在第二个例子中,注释以三个单引号开头和结尾,并以双引号括起字符串。

在使用多行注释时,请确保注释不会包含任何语法错误,否则可能导致代码出错。

多行注释通常用于文档字符串(docstring)中,以记录模块、类、函数等的文档。可以使用 doc 属性访问文档字符串,例如:


class MyClass:
    """
    这是一个类的文档字符串。
    """

print(MyClass.__doc__)

输出:

这是一个类的文档字符串。

在编写 Python 代码时,使用多行注释可以提高代码的可读性和可维护性,特别是对于其他开发人员来说。