如何在VS Code中为自定义Python函数添加自定义提示？

Python里有对应的实现方式，用**文档字符串（docstring）**就能实现和C#类似的悬停提示效果，VS Code的Python插件（如Pylance）会自动识别这些注释并在鼠标悬停时显示提示内容。

文档字符串是用三重引号（"""或'''）包裹的字符串，直接写在函数、类或模块的定义下方第一行即可，常见有几种主流风格，都能被VS Code识别：

1. Google风格（简洁易读） #

def calculate_sum(a: int, b: int) -> int:
    """计算两个整数的和

    Args:
        a: 第一个整数参数
        b: 第二个整数参数

    Returns:
        两个整数相加的结果
    """
    return a + b

2. NumPy风格（详细规范） #

def calculate_sum(a: int, b: int) -> int:
    """计算两个整数的和

    Parameters
    ----------
    a : int
        第一个整数参数
    b : int
        第二个整数参数

    Returns
    -------
    int
        两个整数相加的结果
    """
    return a + b

3. reStructuredText风格（Sphinx文档常用） #

def calculate_sum(a: int, b: int) -> int:
    """计算两个整数的和

    :param a: 第一个整数参数
    :type a: int
    :param b: 第二个整数参数
    :type b: int
    :return: 两个整数相加的结果
    :rtype: int
    """
    return a + b

只要按上述方式编写文档字符串，鼠标悬停在函数名上时，VS Code就会显示对应的提示内容，和内置函数len()的提示效果一致。

内容的提问来源于stack exchange，提问作者cael hansen