我正在阅读 sphinx 文档页面,讽刺的是发现关于 var、ivar 和 cvar 之间差异的文档非常缺乏。我想知道是否有人可以解释内联代码中每个不同名称空间之间的区别。
Example:
class foo(object):
"""
:var str first:
:ivar str last:
:cvar str middle:
"""
这些 sphinx 标签之间有何不同?我如何知道哪一个是正确的,可以按照设计正确使用?
var
当然,是一个通用变量。当您不想进一步区分正在记录的变量时,请使用此选项。
ivar
是一个“实例变量”,或者是在实例对象(类的实例)上设置的变量。通常这些会被定义(在Python中)在一个__init__
method.
cvar
是“类变量”,或者直接在类对象上设置的变量。通常,这将在类语句内设置,但在类中的任何特定方法之外。
这是一个例子:
class SomeClass(object):
cvar = 'I am a class variable'
def __init__(self):
self.ivar = 'I am an instance variable'
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)