在Python中,三引号(三个连续的单引号 '''
或三个连续的双引号 """
)通常用于定义多行字符串或文档字符串(docstring)。这两种形式在Python中是完全等效的,只是根据个人或团队的编码风格选择使用哪一种。
1. 多行字符串
三引号允许你定义一个跨越多行的字符串,而无需在每行的末尾使用转义字符(如\n
)。这在编写包含多行文本的字符串时非常有用。
示例:
multi_line_string = '''
这是一个多行字符串。
它可以包含
多行文本,
而无需在每行末尾添加转义字符。
'''
print(multi_line_string)
输出:
这是一个多行字符串。
它可以包含
多行文本,
而无需在每行末尾添加转义字符。
2. 文档字符串(docstring)
文档字符串是定义在函数、类、模块或方法开始处的特殊注释,用于解释其用途、参数、返回值等。它们通常使用三引号来定义,以便可以包含多行文本和格式化文本(如使用Markdown)。
示例:
def greet(name):
"""
这个函数用于向用户打招呼。
参数:
name (str): 用户的名字。
返回:
str: 打招呼的消息。
"""
return f"Hello, {name}!"
print(greet.__doc__) # 打印函数的文档字符串
输出:
这个函数用于向用户打招呼。
参数:
name (str): 用户的名字。
返回:
str: 打招呼的消息。
注意,尽管文档字符串在代码中通常作为注释存在,但它们可以被Python的内置函数(如help()
)或外部文档生成工具(如Sphinx或MkDocs)用来生成API文档或帮助信息。因此,为函数、类和模块编写清晰、有意义的文档字符串是一种很好的编程实践。