文档源代码

创建文档注释

为 Python 函数创建文档注释

为 Python 函数创建文档注释

  1. 将插入符号放在要记录的函数声明之后。

  2. 键入开三引号，然后按Enter或Space。

  3. 添加有意义的参数和返回值描述。

使用意图操作为 Python 函数创建文档注释

  1. 将插入符号放在要记录的函数中的某个位置。

  2. 按下Alt+Enter以显示可用的意图操作。

  3. 选择插入文档字符串存根：

    意图操作：插入文档存根

    PyCharm 根据 docstring 格式生成文档注释存根，在Python Integrated Tools页面中选择。

Python 注释示例

考虑以下函数：

def 句柄（自我，myParam1，myParam2）：

在Python 集成工具页面中，选择Epytext。然后键入开头的三引号并按Enter或Space。PyCharm 生成文档注释存根：

''' @param self: @param myParam1: @param myParam2: @return: '''

然后选择reStructuredText，输入三引号并按Enter或Space。PyCharm 生成文档注释存根：

''' :param self: :param myParam1: :param myParam2: :return: '''
最后修改：2021 年 12 月 10 日
管理文档评论 生成参考文档