Python函数文档规范_docstring说明【教程】

python函数的文档字符串是被解释器识别的正式文档，必须位于函数体第一行且为三引号包裹的字符串字面量，用于支持智能提示和api文档生成。

Python函数的文档字符串（docstring）不是可有可无的注释，而是被解释器识别、能被工具自动提取的正式文档。写好 docstring，能让别人（包括未来的你）快速理解函数用途、参数含义和返回逻辑，也支持 IDE 智能提示、Sphinx 自动生成 API 文档等关键功能。

Tana

“节点式”AI智能笔记工具，支持超级标签。

下载

docstring 的基本位置和格式

docstring 必须是函数体内的第一行语句，且必须是字符串字面量（用三引号 """ 或 ''' 包裹），不能是注释或变量赋值。

• ✅ 正确：
  def add(a, b):
    """返回两个数的和。"""
    return a + b
• ❌ 错误：
  def add(a, b):
    # "返回两个数的和。"