Solitaire

大事な話が抜けていた。
そう、ドキュメントだよ！！
Pythonのドキュメントは簡単に使う事が出来るので、非常に便利。
まず、基本。
pydoc time
で、timeモジュールのドキュメントを見ることが出来る。
更に、これはビルトインモジュールだけでなく、自前のライブラリにも使える。
例えば、自分が以前に作った、cnclass.pyのドキュメントを見たいと思ったら
pydoc cnclass
とすればいい。ここで驚きなのが、継承、引数、戻り値に関しては自動生成してくれる。
ドキュメント文章は、メソッドの宣言の下に書くと、それが追加される。

例えば、

class MyClass:
    ”"”
    Base Class for other classes in this module
    ”"”
    def printer():
        ”"”
        print attribute
        ”"”
        print x

という感じに書くと、pydoc できちんとドキュメント文字列も表示される。
きちんと、インデントを揃えるのを忘れてはいけない。
IDLEの中であれば、helpを使って見ることもできる。
この場合は、きちんとimportを事前に行う必要性がある。
また、__doc__属性にも、ドキュメントは入っている。

import time

help(time)
print time.__doc__

といった感じ。
読むためのツールとしてはGUIのもあるので、そちらを使うのもいいだろう。