使用 Docstring 指定类型

简介

您会持续调试代码，现在在调试过程中，您还可以收集类型信息并在 Docstring 中指定这些类型。

PyCharm 提供了一种意图操作，使您可以在运行时收集类型信息并定义类型说明。

然而，也完全可以在没有调试器的情况下手动指定参数的类型。

这两种情况都在示例部分中进行了探讨。

指定类型

指定参数类型

按 Ctrl+Alt+S 并转到编辑器 | 常规 | 智能键 | Python。
请选择在文档注释存根中插入类型占位符复选框。
将插入点放在函数名称处，然后按 Alt+Enter。
在打开的意图操作列表中，选择插入 docstring 存根。 PyCharm 根据所选的 Docstring 格式创建一个文档存根，其中包含在调试器会话期间收集的类型说明。

指定返回类型

您还可以为函数的返回值编写文档。 PyCharm 将生成 :return: 和 :rtype: 部分（或其在所选 docstring 格式中的对应项）。

将插入点放在函数名称处，然后按 Alt+Enter。
在打开的意图操作列表中，选择指定 docstring 中的返回值类型。

示例

请考虑以下代码：

            import math

            class SimpleEquation:
                def demo(self, a, b, c):
                    d = math.sqrt(abs(b ** 2 - 4 * a * c))
                    root1 = (-b + d) / (2 * a)
                    root2 = (-b - d) / (2 * a)
                    return root1, root2

            SimpleEquation().demo(3, 2, 1)
        
  

手动指定类型

将插入点放在函数名称处（此处为 demo）。建议的意图操作是插入 docstring 存根。有关更多信息，请参阅创建文档注释。
点击此意图以生成 reStructuredText 格式的文档注释模板：
手动指定所需的参数类型：
顺便说一下，您可以为函数使用快速文档。如果您将插入点放在函数名称处并按 Ctrl+Q ，您将看到：

请注意，使用 reStructuredText 时，可通过两种格式指定类型：

:param param_type param_name: parameter description （类型说明与参数说明在同一行）。
:type param_name: param_type （类型说明在单独的行上）

以下显示了两种变体：

借助调试器指定类型

按 Ctrl+Alt+S 并转到构建、执行、部署 | Python 调试器。在调试器页面中，选择收集运行时信息以提供代码洞察复选框。
调试函数调用。将插入点放在函数名称处，然后按 Alt+Enter。在打开的意图操作列表中，选择插入 docstring 存根。
在调试会话期间获得的关于参数和返回值的信息将用于预填充 Docstring 中的类型注解。
检查结果：

最后修改日期： 2025年 9月 26日