Question

有什么办法可以在sphinx文档中自动显示变量 var1 和 var2 及其初始值吗？

class MyClass:
    """    
    Description for class
    """

    def __init__(self, par1, par2):
       self.var1 = par1 * 2
       self.var2 = par2 * 2

    def method(self):
       pass

Answer 1

您的变量是实例变量，而不是类变量。

如果没有将文档字符串（或#:“doc comment”）附加到变量，则不会记录它们。你可以这样做：

class MyClass(object):
    """    
    Description for class 

    """

    def __init__(self, par1, par2):
        self.var1 = par1 #: initial value: par1
        self.var2 = par2 #: initial value: par2

    def method(self):
        pass

但我更愿意使用info fields包含变量文档：

class MyClass(object):
    """    
    Description for class

    :ivar var1: initial value: par1
    :ivar var2: initial value: par2
    """

    def __init__(self, par1, par2):
        self.var1 = par1 
        self.var2 = par2 

    def method(self):
        pass

另见：

如何在sphinx doc中显示实例属性？

1 个答案: