python 注释多行

原创

mob649e815f494b 2023-09-05 09:29:13 ©著作权

文章标签 多行注释 Python 字符串 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e815f494b的原创作品，请联系作者获取转载授权，否则将追究法律责任

Python 注释多行

在编写Python代码时，注释是一种非常重要的工具。注释可以帮助我们更好地理解代码的功能和逻辑，方便团队合作和维护。除了单行注释外，Python还提供了多行注释的功能，本文将介绍如何在Python中使用多行注释，并给出一些示例代码。

单行注释

在Python中，使用 # 符号可以创建单行注释。在 # 符号之后的所有内容都会被解释器忽略，不参与实际的代码执行。

下面是一个例子：

# 这是一个单行注释
print("Hello, World!")

# 输出结果：
# Hello, World!

单行注释适合用于给代码添加简短的说明或者注解。

多行注释

多行注释可以在一次性中添加多行注释，并且这些注释不会被解释器执行。在Python中，我们可以使用三个引号(''' 或 """)来创建多行注释。

下面是一个使用多行注释的示例：

'''
这是一个多行注释的示例
可以在这里添加对代码的详细描述或者文档
'''
print("Hello, World!")

# 输出结果：
# Hello, World!

可以看到，多行注释之间的文本不会被执行，只有代码部分会被解释器执行。

多行注释在编写长代码时非常有用，可以帮助我们更好地组织和解释代码逻辑。

文档字符串

在Python中，多行注释也可以用作文档字符串（docstring）。文档字符串是位于函数、类或模块的顶部的多行注释，用于为代码提供详细的描述和说明。文档字符串可以通过特殊属性 __doc__ 访问。

下面是一个使用文档字符串的示例：

def add(a, b):
    """
    这个函数用于计算两个数的和
    参数：
    - a: 第一个数
    - b: 第二个数
    返回值：
    - 两个数的和
    """
    return a + b

# 使用文档字符串打印函数的说明
print(add.__doc__)

# 输出结果：
# 这个函数用于计算两个数的和
# 参数：
# - a: 第一个数
# - b: 第二个数
# 返回值：
# - 两个数的和

可以看到，通过在函数定义的下方添加多行注释，我们可以为函数提供详细的说明和注解。这对于代码的维护和使用非常有帮助。