Doxygen

出典: フリー百科事典『ウィキペディア(Wikipedia)』
移動: 案内検索
Doxygen
開発元 Dimitri van Heesch
最新版 1.8.5 / 2013年8月25日
対応OS GNU/Linux, Windows, Mac OS X, Solaris
種別 ドキュメンテーションジェネレータ
ライセンス GNU General Public License
公式サイト http://www.doxygen.org/
テンプレートを表示

Doxygen(ドキシジェン)は、C++C言語JavaObjective-CPythonIDLCORBAおよびマイクロソフト形式)のためのドキュメンテーションジェネレータである。他にも PHPC#D言語ActionScriptでもある程度利用可能。多くのUnix系システム、WindowsMac OS Xで動作する。Doxygenのコードの大部分は Dimitri van Heesch が書いた。

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

概要[編集]

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

コード例[編集]

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

/**
 * The time class represents a moment of time.
 *
 * \author John Doe
 */
class Time {

  /**
   * Constructor that sets the time to a given value.
   * \param timemillis is a number of milliseconds passed since Jan 1. 1970
   */
  Time(int timemillis) {
    ...
  }

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

関連項目[編集]

外部リンク[編集]