モジュールを読み込んで、そのモジュール(クラスまたはメソッド)の概要を知りたいとき。
例えば、
import os
とosモジュールを読み込んで。
os.__doc__
どんなモジュールなのかをさらっと教えてくれる。
python親切。
ためしに書いてみた。
- doc.py -
# -*- coding: utf-8 -*- def testdoc(a,b): """__doc__の呼び出し。この関数は引数の合計をだします""" return a+b if __name__ == '__main__': print testdoc.__doc__
以上のファイルをコマンドラインから実行すると、
引用符に挟まれた部分が表示される。