创建文档注释

为 Python 函数创建文档注释

提示

请注意以下事项：

• 仅当编辑器设置的“智能键”页面中的“插入对引号”复选框被清除时，输入打开三引号后按下时才会生成文档字符串。Space

• 如果您重命名函数的参数，PyCharm 将相应地更新文档注释中的标记。

Python 文档注释示例

考虑以下函数：

def handle(self, myParam1, myParam2):

打开设置并导航至“工具”|“ Python 集成工具。CtrlAlt0S

在Docstring 格式下拉列表中，选择Epytext：

然后键入开头的三个双引号并按或。PyCharm 生成Epytext格式的文档注释存根：EnterSpace

"""

@param self:
@param myParam1:
@param myParam2:
@return:
"""

返回settings( )中的Python Integrated Tools页面，将Docstring格式切换为reStructuredText。然后键入开头的三个双引号并按或。PyCharm 生成reStructuredText格式的文档注释存根：CtrlAlt0SEnterSpace

"""

:param self:
:param myParam1:
:param myParam2:
:return:
"""

您可以使用标记进行文本格式化，以及替换、项目符号列表、链接、代码块和表格：