Python docstring（文档字符串）是写在函数、类、模块或方法定义下方的一段字符串，用来说明它的用途、参数、返回值等信息。它不是普通的注释，而是可以通过特殊属性访问的字符串对象，通常用三重引号 ''' 或 """ 包裹。
docstring 主要用于生成代码文档，帮助其他开发者理解代码功能。它是 Python 内建支持的文档机制，可以被工具如 help()、pydoc 和 Sphinx 自动提取内容。
例如：
def add(a, b):
"""
返回两个数的和。
参数:
a (int): 第一个数
b (int): 第二个数
返回:
int: 两数之和
"""
return a + b
调用 help(add) 时，就会显示这个 docstring 内容。
立即学习“Python免费学习笔记（深入）”；
每个带有 docstring 的对象都有一个 __doc__ 属性，可以直接查看。
社区中常用的格式有几种，选择一种并保持项目内统一即可。
写好 docstring 能提升代码可读性和可维护性，尤其在团队协作或开源项目中非常重要。
基本上就这些。只要在定义后第一行加上三引号字符串，Python 就会把它当作正式文档处理。不复杂但容易忽略。
以上就是python docstring是什么的详细内容，更多请关注php中文网其它相关文章！
python怎么学习？python怎么入门？python在哪学？python怎么学才快？不用担心，这里为大家提供了python速学教程(入门到精通)，有需要的小伙伴保存下载就能学习啦！
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号
199
收藏
