如何让PyCharm实现类似VSCode autoDocstring的带类型Docstring生成？

方法一：配置PyCharm自带功能 #

PyCharm原生支持基于Type Hints自动生成带类型信息的Docstring，只需调整以下设置：

• 打开设置（快捷键 Ctrl+Alt+S），进入 Tools > Python Integrated Tools
• 在Docstring Format下拉菜单中选择NumPy（与VSCode autoDocstring默认格式一致）
• 勾选下方的Insert type hints选项
• 确认设置后，在函数内输入"""并回车，即可生成包含参数类型、默认值的Docstring，效果如下：

def split_dataset(
        data: torch_geometric.data.Data,
        train: float = 0.1,
        test: float = 0.8,
        val: float = 0.1,
) -> tuple:
    """
    Parameters
    ----------
    data : torch_geometric.data.Data
    train : float, optional
        Default: 0.1
    test : float, optional
        Default: 0.8
    val : float, optional
        Default: 0.1

    Returns
    -------
    tuple
    """
    pass

方法二：使用第三方插件增强 #

若需要更灵活的格式自定义，可安装Docstring Generator插件：

• 打开插件市场（Settings > Plugins），搜索并安装Docstring Generator
• 选中目标函数，使用快捷键Alt+Insert（或右键选择Generate > Generate Docstring），即可生成完全匹配VSCode autoDocstring效果的带类型信息Docstring，支持多种格式配置。

内容的提问来源于stack exchange，提问作者Miku ShaneG