日記/2013-07-18/python プログラムのドキュメンテーション
をテンプレートにして作成
[
トップ
] [
新規
|
一覧
|
単語検索
|
最終更新
|
ヘルプ
] [
リンク元
]
開始行:
* python プログラムのドキュメンテーション [#xca42eaf]
仕事で python をいじることになってしまって,あわてて開発...
お仕事でやるわけなので,ドキュメンテーションは外せない.
で,クラス・メソッド・関数のリファレンスなんかのソースコ...
こういうツールの起源は,クヌース生成の weave / tangle に...
** pydoc [#dfd4a949]
python 標準のドキュメンテーションツール.
プログラム内に埋め込まれた docstring という文字列を抽出し...
perl での perldoc みたいな立場なのかな.
困るところは
- unicode 文字列は受け付けない.エラーを吐く
- (非 unicode の)文字列だと表示は問題ないようだ.
-- pydoc コマンドでの端末出力も,問題ない
-- web サーバも問題無し
-- けど,これって python 2.x 系だとどうなのよ,ってのはあ...
- pdf 出力できないのが困りもの
** epydoc [#d8985d4f]
- 本家サイト http://epydoc.sourceforge.net/
- pydoc を拡張し,docstring 内に構文タグを埋め込めるよう...
- pdf 出力可能
- 野ざらし状態のプロジェクト
-- 最新リリースが 5 年前
** sphinx [#g7584cd7]
- 本家サイト: http://sphinx-doc.org/
- 日本語サイト: http://sphinx-users.jp/doc10/index.html
- 最近はこちらが流行りらしい
- あまり調べてない
** doxygen [#md2f1180]
- 本家サイト: http://www.stack.nl/~dimitri/doxygen/
- 日本語サイト: http://www.doxygen.jp/
- 有名なドキュメンテーションツール
- C, Java などいろんな言語に対応
- docstring に対応
-- pydoc 同様,docstring をそのまま抽出するだけで,docstr...
- doxygen コメントも記述可能.
-- コメント内は @param などの構文を使える
- pdf 出力が可能
** で,結局 [#rd6cdffa]
コーディングルールの絡みもあって doxygen に日和ることに.
終了行:
* python プログラムのドキュメンテーション [#xca42eaf]
仕事で python をいじることになってしまって,あわてて開発...
お仕事でやるわけなので,ドキュメンテーションは外せない.
で,クラス・メソッド・関数のリファレンスなんかのソースコ...
こういうツールの起源は,クヌース生成の weave / tangle に...
** pydoc [#dfd4a949]
python 標準のドキュメンテーションツール.
プログラム内に埋め込まれた docstring という文字列を抽出し...
perl での perldoc みたいな立場なのかな.
困るところは
- unicode 文字列は受け付けない.エラーを吐く
- (非 unicode の)文字列だと表示は問題ないようだ.
-- pydoc コマンドでの端末出力も,問題ない
-- web サーバも問題無し
-- けど,これって python 2.x 系だとどうなのよ,ってのはあ...
- pdf 出力できないのが困りもの
** epydoc [#d8985d4f]
- 本家サイト http://epydoc.sourceforge.net/
- pydoc を拡張し,docstring 内に構文タグを埋め込めるよう...
- pdf 出力可能
- 野ざらし状態のプロジェクト
-- 最新リリースが 5 年前
** sphinx [#g7584cd7]
- 本家サイト: http://sphinx-doc.org/
- 日本語サイト: http://sphinx-users.jp/doc10/index.html
- 最近はこちらが流行りらしい
- あまり調べてない
** doxygen [#md2f1180]
- 本家サイト: http://www.stack.nl/~dimitri/doxygen/
- 日本語サイト: http://www.doxygen.jp/
- 有名なドキュメンテーションツール
- C, Java などいろんな言語に対応
- docstring に対応
-- pydoc 同様,docstring をそのまま抽出するだけで,docstr...
- doxygen コメントも記述可能.
-- コメント内は @param などの構文を使える
- pdf 出力が可能
** で,結局 [#rd6cdffa]
コーディングルールの絡みもあって doxygen に日和ることに.
ページ名:
-->