为源代码编写文档

基础

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

源代码中的文档注释可用于 代码参考信息 ，并可在按下 Ctrl+Q 时打开以供查看。

Python 文档

文档注释可以按照在项目设置（Ctrl+Alt+S ）中的 Python 集成工具 页面所选的语法创建。

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

例如，对于 reStructuredText：为函数签名中声明的每个参数生成 :param 标签，以及 :return 标签。

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

在 Python 文件中，PyCharm 会识别以 Python 文档字符串 形式表示的文档注释。

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

另请注意，PyCharm 会从 conf.py 中捕获自定义角色。 配置包含 *.rst 文件的目录时，请指向包含 conf.py 的目录（Python 集成工具 | 包含 *.rst 文件的目录路径）。