创建文档注释
为 Python 函数创建文档注释
要为 Python 函数创建文档注释
将插入符号放在您要编写文档的函数的声明 之后。
输入开头的三个引号，然后按 Enter 或 Space。
为参数和返回值添加有意义的说明。
使用意图操作为 Python 函数创建文档注释
将插入符号置于您要编写文档的函数内的任意位置。
按 Alt+Enter 显示可用的意图操作。
选择 插入文档字符串存根：
PyCharm 会根据在 Python 集成工具 页面中选择的文档字符串格式生成文档注释存根。
Python 文档注释示例
请考虑以下函数：
def handle(self, myParam1, myParam2):
打开设置 Ctrl+Alt+S ，然后导航到 。
在 Docstring 格式 下拉列表中，选择 reStructuredText。
然后输入开头的三重双引号，并按 Enter 或 Space。 PyCharm 会以 reStructuredText 格式生成文档注释存根：
"""
:param self:
:param myParam1:
:param myParam2:
:return:
"""
您可以使用标记进行文本格式设置，以及替换、项目符号列表、链接、代码块和表格。
最后修改日期： 2025年 12月 2日