📜  如何在python中注释多行(1)

📅  最后修改于: 2023-12-03 14:52:50.858000             🧑  作者: Mango

如何在Python中注释多行

在Python中,注释是用来解释代码功能或留下备注的一种方式,而多行注释是用来对一段较长的代码进行注释的方式。本文将介绍Python中多行注释的方式。

1. 使用三个单引号或双引号

Python中的多行注释可以使用三个单引号或双引号来注释一段代码,例如:

'''
这是一段多行注释:
print("Hello World")
print("你好,世界")
'''

或者

"""
这是一段多行注释:
print("Hello World")
print("你好,世界")
"""

需要注意的是,这种注释方式是将多行字符串放在了代码中,虽然这些字符串的内容不会被解释器执行,但是会被编译成字节码,因此不适合注释大量的代码。

2. 使用#注释符号

另一种注释多行的方式是使用“#”注释符号,如下所示:

# 这是一段多行注释:
# print("Hello World")
# print("你好,世界")

即在每一行的代码前添加“#”符号来注释掉整行代码,在需要取消注释时,只需要删除“#”符号即可。

3. 使用块注释

还可以使用块注释的方式来注释多行代码,块注释用一对三个单引号或双引号将多行代码包裹起来,如下所示:

"""
这是一段多行注释:
print("Hello World")
print("你好,世界")
"""

这种注释方式与第一种类似,只不过在注释符号外层加上了一对引号,因此适合注释较大量的代码。

4. 使用文档字符串

最后一种注释多行的方式是使用文档字符串来注释代码,即在函数和模块的开头使用一段字符串来描述该函数或模块的功能和参数等信息。例如:

def print_many(text: str, times: int):
    """
    多次输出指定的文本

    text: str,要输出的文本
    times: int,输出次数
    """
    for i in range(times):
        print(text)

可以看到,文档字符串的格式为在函数或模块开头使用三个单引号或双引号,然后在其中描述函数或模块的功能和参数等信息。当使用help()函数时,可以查看文档字符串:

help(print_many)

上述代码输出:

Help on function print_many in module __main__:

print_many(text: str, times: int)
    多次输出指定的文本

    text: str,要输出的文本
    times: int,输出次数

这种注释方式不仅可以注释多行代码,还可以为函数和模块提供必要的文档和说明。

总结

以上是Python中多行注释的几种方式,具体的使用应根据实际情况选择不同的方式。如果需要注释大量代码,建议使用块注释或文档字符串方式。