在Python中，三个双引号（`"""`）主要有两个核心用途：**文档字符串**和**多行字符串**。让我通过详细的解释和代码示例来说明这两种用法。 ## 1. 文档字符串（Docstring） 文档字符串是Python中用于为模块、类、方法或函数提供文档说明的特殊字符串。在您提供的代码示例中，三个双引号就是用作文档字符串。 ### 基本语法和特点 ```python def greet(name): """向指定的人打招呼""" return f"Hello, {name}!" ``` **文档字符串的核心特性：** * **位置要求**：必须是函数、类或模块的第一个语句 * **访问方式**：可以通过`__doc__`属性或`help()`函数访问 * **格式规范**：遵循PEP 257约定的格式标准 ### 实际应用示例 ```python # 访问文档字符串的两种方式 print(greet.__doc__) # 输出: 向指定的人打招呼 help(greet) # 显示完整的函数帮助信息 ``` ### 更复杂的文档字符串示例 ```python def calculate_area(radius): """ 计算圆的面积 参数: radius (float): 圆的半径，必须为非负数 返回: float: 圆的面积 异常: ValueError: 当半径小于0时抛出 示例: >>> calculate_area(5) 78.53981633974483 """ if radius < 0: raise ValueError("半径不能为负数") return 3.141592653589793 * radius ** 2 # 使用文档字符串 print(calculate_area.__doc__) ``` ## 2. 多行字符串 三个双引号还可以用于创建跨越多行的字符串，这在需要保留格式的文本中特别有用。 ### 基本用法 ```python # 多行字符串示例 multiline_text = """ 这是一个多行字符串的示例。 第一行：欢迎学习Python 第二行：三个双引号可以创建多行文本 第三行：保持原有的换行和缩进格式 """ print(multiline_text) ``` ### 实际应用场景 ```python # SQL查询语句 sql_query = """ SELECT user_id, user_name, email FROM users WHERE status = 'active' AND created_date > '2023-01-01' """ # 格式化输出模板 email_template = """ 亲爱的{name}： 感谢您使用我们的服务。 您的订单号是：{order_id} 订单状态：{status} 如有问题，请联系客服。 """ print(email_template.format(name="张三", order_id="12345", status="已发货")) ``` ## 3. 文档字符串的最佳实践 ### 完整的文档字符串结构 ```python class BankAccount: """银行账户类 这个类用于管理银行账户的基本操作，包括存款、取款和查询余额。 属性: account_holder (str): 账户持有人姓名 balance (float): 账户余额 account_number (str): 账户号码 方法: deposit(amount): 存款操作 withdraw(amount): 取款操作 get_balance(): 查询余额 """ def __init__(self, account_holder, initial_balance=0): """初始化银行账户 参数: account_holder (str): 账户持有人姓名 initial_balance (float, 可选): 初始余额，默认为0 异常: ValueError: 当初始余额为负数时抛出 """ if initial_balance < 0: raise ValueError("初始余额不能为负数") self.account_holder = account_holder self.balance = initial_balance self.account_number = self._generate_account_number() def _generate_account_number(self): """生成唯一的账户号码""" import uuid return str(uuid.uuid4())[:8] def deposit(self, amount): """存款操作 参数: amount (float): 存款金额 返回: float: 更新后的余额 异常: ValueError: 当存款金额小于等于0时抛出 """ if amount <= 0: raise ValueError("存款金额必须大于0") self.balance += amount return self.balance def withdraw(self, amount): """取款操作 参数: amount (float): 取款金额 返回: float: 更新后的余额 异常: ValueError: 当取款金额小于等于0或超过余额时抛出 """ if amount <= 0: raise ValueError("取款金额必须大于0") if amount > self.balance: raise ValueError("余额不足") self.balance -= amount return self.balance def get_balance(self): """查询当前余额 返回: float: 当前账户余额 """ return self.balance # 使用文档字符串 account = BankAccount("李四", 1000) print(account.__doc__) # 查看类文档 print(account.deposit.__doc__) # 查看方法文档 ``` ## 4. 单引号、双引号与三引号对比 为了更清晰地理解三种引号的区别，请看下面的对比表格： | 引号类型 | 语法 | 主要用途 | 特点 | |---------|------|----------|------| | 单引号 | `' '` | 单行字符串 | 简洁，适用于简单字符串 | | 双引号 | `" "` | 单行字符串 | 可以包含单引号而不需要转义 | | 三引号 | `""" """` 或 `''' '''` | 文档字符串和多行字符串 | 保留格式，支持换行和缩进 | ### 使用场景对比示例 ```python # 单引号 - 简单字符串 simple_str = 'Hello World' # 双引号 - 包含单引号的字符串 quote_str = "He said: 'Python is awesome!'" # 三引号 - 多行文本和文档 doc_str = """ 这是一个 多行文本 示例 """ def example_function(): """这是一个文档字符串的示例 详细说明函数的功能和使用方法。 """ pass ``` ## 5. 实际开发中的应用建议 在您的原始代码中： ```python def greet(name): """向指定的人打招呼""" # ← 这是文档字符串 return f"Hello, {name}!" ``` **最佳实践建议：** 1. **为所有公共函数添加文档字符串** 2. **遵循一致的文档字符串格式**（如Google风格、NumPy风格等） 3. **在文档字符串中包含参数、返回值和异常说明** 4. **使用三引号创建需要保留格式的长文本** 通过使用三个双引号作为文档字符串，您不仅为代码提供了清晰的文档，还使得其他开发者（包括未来的您）能够更容易地理解和使用这些函数。这种实践是Python编程中的重要习惯，有助于提高代码的可维护性和可读性。 三个双引号的使用体现了Python"可读性计数"的设计哲学，它让代码文档成为代码本身的一部分，而不是事后补充的注释。这种设计使得Python代码更容易被理解和维护 [ref_1] [ref_3]。