文档源代码

基本

PyCharm 提供了用于创建文档注释的便捷功能。

源代码中的文档注释可作为 代码参考信息，并按 即可打开供审阅。Ctrl0Q

Python 文档

可以根据在项目设置 ( ) 的Python 集成工具页面中选择的语法创建文档注释，例如reStructuredText或epytext。CtrlAlt0S

如果此功能适用于函数，PyCharm 会根据所选的文档字符串格式生成标签，例如：

• 对于reStructuredText：:param函数签名中声明的每个参数的标签，以及:return标签。

• 对于 epytext：@param函数签名中声明的每个参数的标签和@return标签。

reStructuredText和epytext标记中的标签会相应地突出显示。

如果配置，可以使用type和rtype标签生成文档注释存根。

在 Python 文件中，PyCharm 识别以Python docstrings表示的文档注释。

在开始之前，请确保在“设置”对话框的“Python 集成工具”页面中选择了所需的文档字符串格式，例如epytext或。reStructuredText

另请注意，PyCharm 从conf.py捕获自定义角色。配置包含*.rst文件的目录时，请使用conf.py指向该目录（Python Integrated Tools | Path to the directory with *.rst files）。