doxygenとは? わかりやすく解説

Doxygen

出典: フリー百科事典『ウィキペディア(Wikipedia)』 (2025/04/05 06:25 UTC 版)

Doxygen
作者 Dimitri van Heesch
最新版
1.13.2 / 2025年1月9日 (2か月前) (2025-01-09)[1]
リポジトリ
プログラミング
言語
C++、その他[2]
対応OS Linux, Windows, macOS
種別 ドキュメンテーションジェネレータ
ライセンス GNU General Public License v2.0
公式サイト https://www.doxygen.nl/
テンプレートを表示

Doxygen(ドキシジェンまたはドクシジェン)は、C++C言語JavaC#Objective-CFortranPythonPHPIDL[注釈 1]VHDLLexに対応したドキュメンテーションジェネレータである。他にも、D言語でもある程度利用可能となっている[2]。多くのUnix系システム、WindowsmacOSで動作する。Doxygenのコードの大部分は Dimitri van Heesch によって書かれた。

KDEは文書の一部にDoxygenを利用しており、KDevelopは組み込みでサポートしている。

概要

Javadocのように、Doxygenはコンピュータ言語プログラミング言語)のソースファイルをパースして、コメントから文書を抽出・変換・生成する。Javadocの文法に加えて、Qtツールキットで使われるドキュメンテーションタグをサポートしており、HTML形式だけでなく、CHMRTFPDFLaTeXPostScriptmanページ形式の文書を生成できる。

統合開発環境 (IDE) の中には、プログラム要素に対して記述されたDoxygenコメントをもとに、ツールヒントでそのプログラム要素に関する情報を表示するものも存在する。コード入力補完の際に関数メソッドの各パラメータに対する説明を適宜表示するものもある。

歴史

Doxygen の最初のバージョンは、Zuse Institute Berlinで Roland Wunderling と Malte Zöckler が開発した DOC++ の初期バージョンからコードを借用した。その後、Doxygen コードは Dimitri van Heesch によって書き直された。

コード例

以下のコード例は、Doxygenで文書生成可能な形式である。

/**
 * The time class represents a moment of time.
 *
 * \author John Doe
 */
class Time {
public:
    /**
     * Constructor that sets the time to a given value.
     * \param timeMillis A number of milliseconds passed since Jan 1, 1970.
     */
    explicit Time(long long timeMillis) {
        // ...
    }

    /**
     * Get the current time.
     * \return A time object set to the current time.
     */
    static Time now() {
        // ...
    }
};

コメント内にバックスラッシュ\またはアットマーク@で始まる「特殊コマンド」[3]とその引数 (argument) を記述することで、プログラムソースコード中の各構成要素に対する説明を記述した定形的な文書を自動生成することができる。いくつかの特殊コマンドはJavadocとも互換性があるが、Doxygenでしか使えない独自のものも多い。

脚注

注釈

  1. ^ CORBAマイクロソフトのMIDL形式、UNO/OpenOfficeに対応。

出典

関連項目

外部リンク


doxygen

出典: フリー百科事典『ウィキペディア(Wikipedia)』 (2016/02/22 15:54 UTC 版)

コールグラフ」の記事における「doxygen」の解説

Graphviz用いて静的呼び出し継承の図を生成する

※この「doxygen」の解説は、「コールグラフ」の解説の一部です。
「doxygen」を含む「コールグラフ」の記事については、「コールグラフ」の概要を参照ください。

ウィキペディア小見出し辞書の「doxygen」の項目はプログラムで機械的に意味や本文を生成しているため、不適切な項目が含まれていることもあります。ご了承くださいませ。 お問い合わせ



固有名詞の分類


英和和英テキスト翻訳>> Weblio翻訳
英語⇒日本語日本語⇒英語
  

辞書ショートカット

すべての辞書の索引

「doxygen」の関連用語

doxygenのお隣キーワード
検索ランキング

   

英語⇒日本語
日本語⇒英語
   



doxygenのページの著作権
Weblio 辞書 情報提供元は 参加元一覧 にて確認できます。

   
ウィキペディアウィキペディア
All text is available under the terms of the GNU Free Documentation License.
この記事は、ウィキペディアのDoxygen (改訂履歴)の記事を複製、再配布したものにあたり、GNU Free Documentation Licenseというライセンスの下で提供されています。 Weblio辞書に掲載されているウィキペディアの記事も、全てGNU Free Documentation Licenseの元に提供されております。
ウィキペディアウィキペディア
Text is available under GNU Free Documentation License (GFDL).
Weblio辞書に掲載されている「ウィキペディア小見出し辞書」の記事は、Wikipediaのコールグラフ (改訂履歴)の記事を複製、再配布したものにあたり、GNU Free Documentation Licenseというライセンスの下で提供されています。

©2025 GRAS Group, Inc.RSS