### 使用三引号定义文档字符串的作用 在 Python 中，三引号（`'''` 或 `"""`）可以用来创建多行字符串。当这些三引号被用于函数、类或模块的开头时，它们会被解释器识别为 **文档字符串 (Docstring)**[^1]。 #### 文档字符串的功能 文档字符串的主要功能是对代码提供描述性的说明，帮助开发者理解代码的目的和用法。它不仅提高了代码的可读性和可维护性，还支持动态访问，例如通过内置函数 `help()` 和属性 `__doc__` 来查看文档内容[^2]。 以下是具体的应用场景： #### 定义单行 Docstring 即使是一个简单的函数，也可以使用三引号来编写单行文档字符串： ```python def add(a, b): """Return the sum of two numbers.""" return a + b ``` #### 定义多行 Docstring 对于更复杂的逻辑，可以通过三引号实现多行注释，详细描述参数、返回值以及注意事项： ```python def calculate_area(length, width): """ Calculate the area of a rectangle. Parameters: length (float): The length of the rectangle. width (float): The width of the rectangle. Returns: float: The calculated area of the rectangle. Raises: ValueError: If either length or width is negative. """ if length < 0 or width < 0: raise ValueError("Length and width must be non-negative.") return length * width ``` #### 动态访问 Docstring Python 提供了多种方式来获取对象的文档字符串。例如，可以直接打印 `__doc__` 属性或者调用 `help()` 函数： ```python print(calculate_area.__doc__) # 打印函数的文档字符串 help(add) # 显示交互式的帮助信息 ``` #### 嵌套结构中的 Docstring 除了函数外，在类和模块级别同样可以应用三引号作为文档字符串。这有助于整体项目管理并提升团队协作效率。 ```python class Rectangle: """ Represents a geometric shape called Rectangle. Attributes: length (float): Length dimension. width (float): Width dimension. """ def __init__(self, length, width): self.length = length self.width = width ``` --- ### 总结 三引号在 Python 的文档字符串中扮演着重要角色，能够清晰表达代码意图，并便于其他开发人员理解和扩展程序逻辑。此外，利用标准库工具如 `dir()` 和 `help()` 可进一步增强其价值。