Pydoc

pydoc.png

Pythonのドキュメントのことをpydocというらしい

pythonのインタープリターを起動して、help()を実行すると、モジュールに
記載されたドキュメントが表示できるようになります。

書き方

# -*- coding:utf-8 -*-
"""
ファイルの先頭に書いたコメント
"""
__author__ = "作者 <mail@example.com>"
__status__ = "production"
__version__ = "0.0.1"
__date__    = "01 November 2011"
DATA_TEST = '変数'
class Test(object):
    """
    クラスの先頭に書いたコメント
    """
    def test(self):
        """
        メソッドの先頭に書いたコメント
        """
        pass
 
print("hello world")

pydocをhtmlファイルに変換

htmlファイルに変換

pydocコマンドの引数に「-w」を追加すると、htmlファイルが生成されます。

$ pydoc -w sample
wrote sample.html

サポートサイト Wikidot.com