ソースコード・ドキュメンテーション・ツール

Doxygen は、注釈つきのC++ソースからドキュメントを生成することを目的とする、事実上の標準ツールです。他の一般的なプログラミング言語、C、Objective-C、C#、PHP、Java、Python、IDL (Corba、Microsoft 風)、Fortran、VHDL、Tcl、そして D にもある程度対応しています。

Doxygen には、次の３つの利点があります。

文書化されたソースファイルのセットから、オンライン・ドキュメント・ブラウザ (HTML形式) やオフラインのリファレンス・マニュアル (\LaTeX形式) を生成することができます。 RTF (MS-Word)、PostScript、ハイパーリンク PDF、圧縮 HTML、Unix man ページ形式の出力もサポートされています。ドキュメントは、ソースから直接抽出されます。これにより、ドキュメントとソースコードの一貫性を保つことがとても容易になります。
Doxygen は、文書化されていないソースファイルから、コードの構造を抽出するように設定することができます。これにより、大規模で分散化されたソースの中を探ることが容易になります。様々な要素間の関係が、内包・依存図、継承図、およびコラボレーション図により視覚化されます。しかもすべて自動的に生成されます。
また、通常のドキュメントを作成させることもできます (ユーザーマニュアルやウェブサイトで著者がやっているように)。

Doxygen は、Mac OS X環境及びLinux環境で開発されていますが、高い移植性を考慮して設計してあります。従って、他のほとんどの Unix系システムでも動作します。さらに、Windows 用実行ファイルもあります。

Doxygen ライセンス

Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License for more details.

Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license.

使用例

Doxygenは、HTMLなど多くの \ref output "output formats" 出力フォーマットをサポートしています。作者は、 Doxygen を実際に使用しているプロジェクトを幾つかまとめました。これらは、doxygenを使用しているプロジェクトの一部です。もし他に使用しているプロジェクトをご存じなら作者までお知らせください。リストに追加したいと思います。

将来に向けて

Doxygen は、多くの会社やオープンソースプロジェクトでの成功例がありますが、改良の余地というのは常にあるものです。

機能拡張の要望を、バグトラッカーに提出できます。バグレポートの重要度を"enhancement"にしてください。

謝辞

Malte Zöckler and Roland Wunderling, authors of DOC++. The first version of doxygen borrowed some code of an old version of DOC++. Although I have rewritten practically all code since then, DOC++ has still given me a good start in writing doxygen.
All people at Qt Software, for creating a beautiful GUI Toolkit (which is very useful as a Windows/Unix platform abstraction layer :-)
My brother Frank for rendering the logos.
Harm van der Heijden for adding HTML help support.
Wouter Slegers of Your Creative Solutions for registering the www.doxygen.org domain.
Parker Waechter for adding the RTF output generator.
Joerg Baumann, for adding conditional documentation blocks, PDF links, and the configuration generator.
Tim Mensch for adding the todo command.
Christian Hammond for redesigning the web-site.
Ken Wong for providing the HTML tree view code.
Talin for adding support for C# style comments with XML markup.
Petr Prikryl for coordinating the internationalization support. All language maintainers for providing translations into many languages.
The band Porcupine Tree for providing hours of great music to listen to while coding.
Andrea Schulte for translating part of the web page to German.
Jan Milz for mirroring the tar ball.
many, many others for suggestions, patches and bug reports.