python プログラムのドキュメンテーション †仕事で python をいじることになってしまって,あわてて開発環境まわりを整備している. お仕事でやるわけなので,ドキュメンテーションは外せない. で,クラス・メソッド・関数のリファレンスなんかのソースコードと対応するあたりは説明をソースコード内に書き込んだほうが間違いが少ないし,そういう説明部を抜き出して個別の文書ファイルを作成してくれるツールもある. こういうツールの起源は,クヌース生成の weave / tangle に遡るのかなぁ. pydoc †python 標準のドキュメンテーションツール. プログラム内に埋め込まれた docstring という文字列を抽出して文書化するもの. perl での perldoc みたいな立場なのかな. 困るところは
epydoc †
sphinx †
doxygen †
で,結局 †コーディングルールの絡みもあって doxygen に日和ることに. |