如何在 VS Code 中获取 Google/Sphinx 风格的 Python 类属性文档的悬停信息？ （如“#：文本”）

Question

我正在尝试记录 Python 类中的实例变量，以便当我将鼠标悬停在它们上方时它们会显示在 VS Code 中。我发现这有效：

class TsCity:

def __init__(self) -> None:
    self.name: str = ""
    """The city name."""

但这太难看了。我理想地希望使用 Google 风格的文档字符串来代替：

self.name: str = ""  #: Doc comment *inline* with attribute

但这并没有正确显示在 VS Code 中。有没有办法让这种类型的文档字符串在 VS Code 中工作？

Answer 1

此 (

#: lorem ipsum

) 是 Sphinx/Google 风格的属性文档（与 pep-0224 风格 (

""" lorem ipsum """

) 相对）

我向 Python 扩展的维护者询问是否存在现有的功能请求问题单，要求提供 Sphinx 风格的属性文档，网址为 https://github.com/microsoft/pylance-release/issues/1576#issuecomment-1668718385。其中一位（Rich Chiodo）回复：

我不这么认为。但如果它不是标准文档字符串的一部分，我们可能需要很多赞成票才能添加它。

我认为这意味着 - 不，在撰写本文时，没有办法获取这种类型的属性文档注释的悬停信息 - 至少无法使用 Microsoft 的 Python 扩展（当时最流行的 Python 扩展）写作）。也许有一个扩展可以增加对此的支持，但我不知道。