nDiki : doxygen

C++、Java、IDL、C 用のドキュメント生成システム。 Graphvizを用いてクラス間の関係のグラフが生成される。

他人のソースコード群をもらったら、とりあえずこれを書けて概略を掴むというのも手。

Cのプログラムの場合はISO C のプロトタイプの形で関数が宣言/定義されている必要がある。 古い形式の場合、protoize 等で変換する必要あり。

Perl XML ドキュメント コメント Pod 日本語 API Javadoc ドキュメンテーションコメント HTML ドキュメンテーションコメント Swing LaTeX C# RD PDF プログラミング言語 IDE プリント Visual C# ソフトウェア Eclipse GCC 仕様 Emacs プラグイン perltidy WiKicker Ruby URL Visual Studio オープンソース 識別子

■ 去年の今ごろ

2001年6月1日より。

• 岩本町・東神田ファミリーバザール
  • 今年も昨日から開催されている。昨年行ってみて、どうも自分の趣向と違うようだったので今年は見にいかなかった。
• Doxygen で Document を Generate
  • これはアタリ。今も利用している(タマにだけど)。Ant から doxygen を呼び出す extension や、Emacs から利用するための doxymacs 等いろいろ便利なツールもある(後者はまだ使った事なし)。

• Linux 上で Flex 2 SDK を使った Flash コンテンツ開... (2007-09-11)
• Eclipse 2.0.2 (2002-11-15)
• YAMLのJava実装を書く (2004-09-03)
• CUPS で Debian から EPSON カラーレーザプリンタへ印刷 ... (2006-01-04)
• Mule-UCS の設定 (2006-03-08)

■ 久しぶりにdoxygen

仕事のJava、C++ ソースコードをドキュメント化するリクエストをもらったので例によって doxygen に通す。 今回は LaTeX 経由でPDFへ。

• assertion (2004-05-16)
• ハッシュとは (2004-06-09)
• reStructuredText いいんじゃない? (2005-11-22)
• 久しぶりに build.xml を書く (2005-11-14)
• LaTeX でプレゼンテーション (2005-06-21)

■ Perl 用の doxygen のようなツールはないのかな

WiKicker のソースコードを人に説明するのにプリントアウトして説明するのに、doxygen のようなツールが欲しいのだけれど Perl 用のものはないのかな。

1. ソースコードを色付けした HTML に変換してくれる
2. Pod とコード本体を混在してドキュメント化してくれる
3. ソースツリー内のファイルをそれぞれ処理してくれて、インデックスファイルも生成してくれる。
4. できれば識別子がリンクになってくれる

というのが希望。1 だけなら結構いろいろなツールがあり、1 + 2 なら perltidy で実現できる。 しかし 3、4 までしてくれるツールが見つけられない。

とりあえず perltidy の Perl::Tidy と File::Find で再帰的にまとめて HTML に変換するスクリプトだけは書いて、一気に変換だけはできるようにしておいた。

インデックスの作成までは面倒なので未着手。

• 第2回 社内 Perl 勉強会 (2006-04-28)
• Perl プリティプリンタの定番 perltidy (2006-04-23)
• Emacs でお好きな言語のソースコードを色付き HTML テキストに変換 (2006-04-21)
• 定型書式で内容を記述していくのに便利な形式は? (2005-11-21)
• WiKicker に JSON でのページ出力機能を追加 (2007-04-03)