在Python中,使用三个单引号 '''
或者三个双引号 """
主要不是用来做注释的,而是用来创建多行字符串或文档字符串(docstrings)。这些多行字符串可以跨越多行,并且在程序运行时不会执行。
注释
如果你想要写多行注释,你可以使用井号 #
来逐行注释,或者在一个大的字符串中写你的注释内容。
示例:
# 这是一个单行注释
# 下面是多行注释的例子
# 第一行注释
# 第二行注释
# 第三行注释
文档字符串 (Docstrings)
当你使用三个引号时,你通常是在创建一个文档字符串。文档字符串是用来描述函数、类或模块用途的特殊类型的字符串。
示例:
def example_function(arg1, arg2):
"""
这是一个文档字符串 (docstring)。
它用来解释这个函数的作用、参数和返回值等信息。
参数:
arg1: 第一个参数
arg2: 第二个参数
返回:
返回 arg1 和 arg2 的和。
"""
return arg1 + arg2
在这个例子中,example_function
的 docstring 描述了函数的功能、参数和返回值。这样的字符串可以通过函数的 __doc__
属性来访问。
多行字符串
如果只是想创建一个多行字符串而不是文档字符串,你也可以这样做:
示例:
multi_line_string = """
这是第一行
这是第二行
这是第三行
"""
print(multi_line_string)
这段代码会输出一个包含三行文本的字符串。希望这能帮助你理解Python中的注释和多行字符串的用法!