pydocの使用例 - /prog/log

pydocを使ってみた。そのメモ書き。
　
　
test.py

# -*- coding:utf-8 -*-
'''ファイルタイトル

これはファイルの先頭に書かれています。
'''

__author__ =  'yufu4'
__version__=  '1.0'
__date__ = '2013/01/15'

DATA = 'data'

class Test1:
    '''
    No.1
    これはクラスの先頭に書かれています。
    '''
    def __init__(self):
        '''
        No.1
        これは__init__の先頭に書かれています。
        '''
        pass

    def method(self):
        '''
        No.1
        これはmethodの先頭に書かれています。
        '''
        pass

class Test2:
    '''
    No.2
    これはクラスの先頭に書かれています。
    '''
    def __init__(self):
        '''
        No.2
        これは__init__の先頭に書かれています。
        '''
        pass

    def method(self):
        '''
        No.2
        これはmethodの先頭に書かれています。
        '''
        pass

def main():
    '''
    これはmainの先頭に書かれています。
    '''
    pass

if __name__ == '__main__':
    pass

　
　
pydocの実行

$ pydoc test

Help on module test:

NAME
    test - ファイルタイトル

FILE
    /Users/mekeby/Desktop/test.py

DESCRIPTION
    これはファイルの先頭に書かれています。

CLASSES
    Test1
    Test2
    
    class Test1
     |  No.1
     |  これはクラスの先頭に書かれています。
     |  
     |  Methods defined here:
     |  
     |  __init__(self)
     |      No.1
     |      これは__init__の先頭に書かれています。
     |  
     |  method(self)
     |      No.1
     |      これはmethodの先頭に書かれています。
    
    class Test2
     |  No.2
     |  これはクラスの先頭に書かれています。
     |  
     |  Methods defined here:
     |  
     |  __init__(self)
     |      No.2
     |      これは__init__の先頭に書かれています。
     |  
     |  method(self)
     |      No.2
     |      これはmethodの先頭に書かれています。

FUNCTIONS
    main()
        これはmainの先頭に書かれています。

DATA
    DATA = 'data'
    __author__ = 'yufu4'
    __date__ = '2013/01/15'
    __version__ = '1.0'

VERSION
    1.0

DATE
    2013/01/15

AUTHOR
    yufu4

　
　
HTMLファイルの書き出し