2012-08-20 17 views
5

PythonでPOD(plain old documentation)を使用することが可能かどうか疑問に思っていましたか?そして私はどうしたらいいですか?PythonでPOD(plain old documentation)を使用することはできますか?

+2

なぜそれが必要ですか? Pythonには、 'pydoc'によって解釈される独自のdocstring形式があります。 PODを使用する場合、モジュールのユーザーはそれを読むためのツールを必要とします。これがあなたが望むものだと確信していますか?あなたのコードを文書化したいだけなら、pythonのdocstringを使います。 – javex

答えて

1

PythonファイルでPODインラインを直接使用する方法はありません。しかし、Pythonモジュール(Python標準ライブラリを含む)はreStructuredTextを使って文書化されています。これは、通常、Sphinxを使用して行われ、reStructuredText形式のドキュメントストリングからドキュメントを生成します。 Sphinxと最初は、PODと同様のニッチを埋めるように特別に設計されました。

関連する問題