perldocの概要:
Perl モジュールを作成するときは、POD
スタイル ドキュメントで文書化できます。次に、モジュールの動作の概要を取得するには、コマンド ラインに次のように入力します。
perldoc <module_name>
Pythonでこれを行うにはどうすればよいですか?
Python には、Perl の POD スタイルにいくぶん似た「docstring」を使用してコードを文書化する標準形式があることを理解しています。help()
関数を使用して Python モジュールに関する情報を抽出できますが、これはエレガントとは言えません。
最初に Python インタープリターを開始する必要があります。次に、ヘルプを取得したいモジュールをインポートします。最後に、help()
関数を使用してモジュールに関する情報を取得できます。
例:
>python
# Prints Python version info
>>>import <module_name>
>>>help(<module_name>)
# Prints documentation!
より良い方法はありますか?
これがPerlで機能する方法と同等のPythonが欲しいです:
pydoc <module_name>
しかし、これを試すと、次の出力が得られます。
'pydoc' is not recognized as an internal or external command,
operable program or batch file.