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