Python 如何让PyCharm在实例属性的文档中显示任意文本? 虽然PyCharm确实支持函数和类型提示的文档字符串,但是我不能找到一种方法来获得对类实例的“公共属性”的广泛描述。
我能得到的最好结果是注释或显式类型提示显示在文档窗格中(Python 如何让PyCharm在实例属性的文档中显示任意文本? 虽然PyCharm确实支持函数和类型提示的文档字符串,但是我不能找到一种方法来获得对类实例的“公共属性”的广泛描述。,python,attributes,pycharm,python-sphinx,docstring,Python,Attributes,Pycharm,Python Sphinx,Docstring,我能得到的最好结果是注释或显式类型提示显示在文档窗格中(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
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打电话。有些电话号码应该在self打,有些电话号码应该在self打。理想情况下,这应该出现在\uuuu init\uuuu
的文档中,但任何地方都比没有地方好
然而,我似乎被完全忽略了,而且self上的ctrl-q
。一些属性告诉我self。一些属性是一个列表[int]
,而上的ctrl-q
告诉我有一个参数name