Kawasaq Blog - いまさら聞けない？ドキュメンテーション文字列と pydoc の出力の関係

ドキュメンテーション文字列とは ドキュメンテーション文字列とは、関数やクラスの説明のためにその関数やクラスの定義の直後に置かれた文字列のことです。 たとえばこういうの def my_function(): """Do nothing, but document it. No, really, it doesn't do anything. """ pass です。 Python チュートリアル 4.7.6 に詳しく書いてあります。 pydoc とは pydoc とは Python の標準ライブラリに含まれるモジュールの１つで、 モジュールやクラスなどのドキュメントを自動で作成して表示するためのものです。 たとえば、 $ pydoc os してみてください。あるいは $ python >>> import pydoc, os >>> pydoc.help(os) してみてください。 pydo

[claddvd]

いまさら聞けない、からブクマ。

[Bell000]

いまさら聞けない？ドキュメンテーション文字列と pydoc の出力の関係