我正在try 在我的Python类中记录实例变量,这样当我将鼠标悬停在它们上面时,它们就会显示在VS代码中.我发现这招很管用:

class TsCity:

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

但这太难看了.理想情况下,我会使用谷歌风格的文档字符串:

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

但这并不能在VS代码中正确显示.有没有办法让这种类型的文档字符串在VS代码中工作?

推荐答案

这(#: lorem ipsum)是Sphinx/Google样式的属性文档(相对于pep-0224样式(""" lorem ipsum """))

我询问了Python扩展的维护人员,关于是否存在要求Sphinx样式的属性文档的https://github.com/microsoft/pylance-release/issues/1576#issuecomment-1668718385版本的特性请求问题单.其中一位(Rich Chiodo)回答说:

我想不行.但如果它不是标准文档字符串的一部分,我们可能需要大量的Up投票才能添加它.

我认为这意味着--不,在 compose 本文时,还没有办法获得这种样式的属性文档注释的悬停信息--至少不能使用Microsoft的Python扩展(在 compose 本文时最流行的Python扩展).也许有一个扩展添加了对此的支持,但我不知道它是什么.如果你最终为这一功能向Microsoft Python repo发出了一张功能请求问题单,请在此处 comments 链接,如果你无法 comments ,请建议编辑这篇文章,添加一个链接.

Python相关问答推荐

Python:记录而不是在文件中写入询问在多文件项目中记录的最佳实践

将轨迹优化问题描述为NLP.如何用Gekko解决这个问题?当前面临异常:@错误:最大方程长度错误

添加包含中具有任何值的其他列的计数的列

如何计算列表列行之间的公共元素

如何避免Chained when/then分配中的Mypy不兼容类型警告?

如何在虚拟Python环境中运行Python程序?

通过pandas向每个非空单元格添加子字符串

从spaCy的句子中提取日期

将JSON对象转换为Dataframe

根据列值添加时区

多指标不同顺序串联大Pandas 模型

如何在达到end_time时自动将状态字段从1更改为0

找到相对于列表索引的当前最大值列表""

Python pint将1/华氏度转换为1/摄氏度°°

统计numpy. ndarray中的项目列表出现次数的最快方法

BeautifulSoup-Screper有时运行得很好,很健壮--但有时它失败了::可能这里需要一些更多的异常处理?

语法错误:文档. evaluate:表达式不是合法表达式

使用Python TCP套接字发送整数并使用C#接收—接收正确数据时出错

Js的查询结果可以在PC Chrome上显示,但不能在Android Chrome、OPERA和EDGE上显示,而两者都可以在Firefox上运行

如何从数据框列中提取特定部分并将该值填充到其他列中?