文章目录
在 Python 中,函数的说明文档(Docstring)可以通过两种主要方式访问:
help()
函数
def example_function(a, b):"""这是一个示例函数,用于演示文档字符串的用法"""return a + bhelp(example_function)
输出:
Help on function example_function in module __main__:example_function(a, b)这是一个示例函数,用于演示文档字符串的用法
__doc__
属性
print(example_function.__doc__)
输出:
这是一个示例函数,用于演示文档字符串的用法
💡 提示:
• 文档字符串应紧跟函数定义,用三引号包裹
• 推荐包含:功能描述、参数说明、返回值说明
• 可通过 Ctrl+Q
(PyCharm等IDE)快速查看文档
• 遵循 PEP 257 规范编写更专业的文档
两种方式的区别:
• help()
会格式化输出并包含额外信息(如模块路径)
• __doc__
直接返回原始字符串,适合程序化处理