记录源代码

基础

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

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

Python 文档

文档注释可以根据项目设置（Ctrl+Alt+S ）中 Python Integrated Tools 页面选择的语法创建。

如果此功能适用于某个函数，PyCharm 会根据选定的 docstring 格式生成标签。

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

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

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

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

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