是否有某种方法可以使用特定类型的实例变量,与sphinx规范一致?
class Foo:
def bar(self):
pass
class Bar:
def foo(self):
pass
class ExampleError(Exception):
"""
:ivar Foo msg: descr
:ivar Bar code: descr
"""
def __init__(self, param, param2):
"""
:param Foo param: descr
:param Bar param2: descr
"""
self.msg = None
self.code = None
此案例正确生成文档。 (包含变量msg,代码及其类型的ExampleError类)
但 self.msg 上的pycharm类型提示不起作用。
如果我使用:
self.msg = param
self.msg 上的类型提示使用:param Foo param:descr
这适用于 msg ,但它对pycharm的攻击:
class ExampleError(Exception):
"""
:var Foo msg: descr
:type msg: Foo
:var Bar code: descr
"""