Doxygenについて詳しく解説

Doxygenは、プログラムのソース コードからドキュメントを作成するための無料のコンピューターソフトウェアです。これを行うために、ソース コードが記述されている言語の文法と、コメントが特定の形式で記述されている場合はコメントが考慮されます。

Doxygen のコードは主に Dimitri van Heesch によって書かれました。

プレゼンテーション

Doxygen は、 dox ( docs 、ドキュメントの英語の略語) とgen ( generator 、ドキュメントジェネレーター) の短縮形です。

Doxygen は、 C 、 C++ 、 Java 、 Objective C 、 Python 、 IDL 、およびある程度のPHP 、 C# 、および D で書かれたソース ファイルを解析できます。

ドキュメントは、HTML (圧縮または非圧縮)、 LaTeX 、RTF、 PostScript 、ハイパーリンク付きの PDF、および近日中に XML (開発中) の形式で生成できます。

興味

Doxygen は、ドキュメントをソース コードに直接統合できるようにすることで、ドキュメントとコード間の一貫性を促進し、開発者の動作を体系化して、開発者が作成したコードを文書化します。

また、これまで文書化されていなかったソース コードから文書を抽出することもできるため、複雑なコードを含むプログラムを理解しやすくなります。

KDEなどの多くのプロジェクトは、Doxygen を使用して API ドキュメントを作成します。 KDevelop には Doxygen のサポートが含まれています。多くのテキスト エディタは、Doxygen コメントの作成やドキュメントの生成を容易にするモードまたはスクリプトを提供しています。

ソースから次の情報を抽出できます。

• ローカル、プライベート、パブリックなどのプロトタイプ関数とドキュメント関数。
• 含まれるファイルのリスト
• データ構造の文書化
• クラスとその階層のプロトタイプとドキュメント
• さまざまなタイプのグラフ: クラス、コラボレーション、コール、包含図など。これらの図の一部を生成するには、無料のDotツールが必要です。
• すべての識別子のインデックス
• 注釈 (行番号など) が付けられ、ナビゲート可能なソース ファイル (HTML など、識別子が関連ドキュメントにリンクしている)

例

以下のコードは、Doxygen でコードを文書化する方法を示しています。

/**
* Timeクラスは瞬間を表します。
* @著者Paul Hochon
*/
クラス時間 {
/**
* ビルダー。
* インスタントを特定の値に設定します。
* @param timemillis 1970 年1 月1 日からの経過ミリ秒
*/
時間( int timemillis) {
...
}
/**
* 現在の瞬間を取得します。
* @return現在の瞬間に対応する瞬間
*/
静的な今の時間() {
...
}}

ターゲット言語 (ここでは Java) のコメントは、それらを考慮する必要があることを Doxygen に示すために特殊化されています。そのため、コメントは/*ではなく/**で開かれます。これらのコメント内の特定のタグも Doxygen によって解釈されます (例: @param )。

この例では、Doxygen と互換性のある Javadoc 形式を使用してコメントを記述します。 Doxygen は、機能的に同等の独自の形式を提供します。

プラットフォーム

Doxygen はLinuxおよびMac OSで書かれており、移植性が重視されています。これはほとんどのUnixシステムで実行でき、 Microsoft Windowsでは実行可能バージョンとして利用できます。

ドキシーウィザード

DoxyWizard は、Doxygen の生成オプションを構成し、ドキュメントの抽出を開始するためのグラフィカルインターフェイスです。 Doxygen と同様に、さまざまなプラットフォームで利用できます。

ライセンス

Doxygen は GPL ライセンスに基づいてリリースされています。