文档字符串

9.3 文档字符串

函数/类第一行用三引号写说明,用 __doc__ 查看。

本节介绍「文档字符串」的用法与注意点,请结合下方代码示例理解。

建议:先读懂注释,再自己动手修改数字或文字,观察输出变化。

💡 遇到报错先看最后一行英文提示,再对照「常见错误与正确对比」。

docstring

以下代码含详细中文注释,可直接复制运行。建议对照输出理解每一行的作用。

# ========================================
# 示例:docstring
# 说明:建议复制到 .py 文件运行,或粘贴到 Python 交互模式
# ========================================
def add(a, b):  # 定义函数
    """返回两数之和"""
    return a + b
print(add.__doc__)  # 输出到屏幕 / 从键盘读入