2011-12-27 10 views

答えて

39

変数はインスタンス変数であり、クラス変数ではありません。

変数にドキュメントストリング(または#: "ドキュメントコメント")を添付しないと、ドキュメント化されません。次のように行うことができます:

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 

も参照してください:

+0

#:docコメントがsphinxのhtmlページに表示されるために必要な設定はありますか?私は.rstファイルを生成するためにsphinx-apidocコマンドを使用しました。 – varunsinghal

+0

@varunsinghal:問題がありますか? – mzjn

+0

私はこれらのドックコメント#:をプライベートクラス変数に使用していました。 – varunsinghal

関連する問題