tetsunosukeのnotebook

tetsunosukeのメモです

pydocの悩み

Pythonでモジュールを書いています。

そこで、ドキュメントもしっかり書きたいな、と思い、クラスのメンバ変数についてドキュメントを書こうと思いました。

こんなコードを書くと

'''test.py
   test
'''

class Test():
    '''Test class'''

    member = 0

    def func():
        '''func method'''
        pass

こんなドキュメントを作ることができます。

FILE
    /private/tmp/test.py

DESCRIPTION
    test.py
    test

CLASSES
    Test
    
    class Test
     |  Test class
     |  
     |  Methods defined here:
     |  
     |  func()
     |      func method
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  member = 0

しかしこれだと、Data and other attributes defined hereな部分にコメントを書けない。メンバ変数の意味を書けないというのは結構しんどい気がする。これを書く方法はないのだろうか???

いろいろ調べていたが、組み込みクラスのBaseExceptionについてはこうなっている。

 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |  
 |  __dict__
 |  
 |  args
 |  
 |  message
 |      exception message

ずるくね???これが書いてある.pyファイルを探したけど見つからなかった。組み込みだもんね、しょうがないよね。