Question

尽管PyCharm确实支持函数和类型提示的文档字符串，但我找不到一种方法来获取关于类实例的“公共属性”的广泛描述。

我能得到的最好的建议是显示在“文档”窗格中的注释或显式类型提示（默认为ctrl-q），无论如何，这都是我可以通过内省得到的：我的目的是获得关于该内容的描述。变量意味着与该变量相反。

from typing import List
class Example:
   def __init__(self, name: str = 'default'):
       """This object is an example, but has some attributes.

       :param name: this name is kind of special because...
       :ivar some_attr: this attr contains phone numbers of friends!
       :ivar some_other_attr: this attr contains phone numbers of enemies!
       """
       self.name = name
       self.some_attr: List[int] = []
       self.some_other_attr: List[int] = []

我希望PyCharm告诉我，我不应该在凌晨3点给self.some_attr号码打电话，而应该专注于self.some_other_attr中那些讨厌的号码。理想情况下，这应该在__init__的文档中发生，但是任何地方总比没有好。

但是我似乎被完全忽略了，ctrl-q上的self.some_attr只是告诉我self.some_attr是List[int]，而ctrl-q上的__init__ }告诉我我有一个参数name。

如何获取PyCharm以在实例属性的文档中显示任意文本？

0 个答案: