python - 如何在 VS Code 中获取 Google/Sphinx 风格的 Python 类属性文档的悬停信息？ (如 "#: text")

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)回复:

I don't believe so. But if it's not part of standard doc strings, it would probably take a lot of up votes for us to add it.

我认为这意味着 - 不，在撰写本文时，还没有办法获取这种类型的属性文档注释的悬停信息 - 至少无法使用 Microsoft 的 Python 扩展(当时最流行的 Python 扩展)写这篇文章)。也许有一个扩展可以增加对此的支持，但我不知道。如果您最终向 Microsoft Python 存储库提交了此功能的功能请求问题票，请在此处评论链接到该功能，或者建议编辑此帖子以添加指向该功能的链接(如果您无法发表评论)。