Last modified: Thu Apr 10 09:24:57 JST 2008

Doxygen

ドキュメントの作成

• Doxygenはソースファイルを読み込み， コメントとして書き込まれた文書からドキュメントを生成する
• Doxygenは HTML や LATEX 形式でドキュメントを生成する

• Dxygenにより作成したドキュメント の例

• ソースファイルとドキュメント化
  Doxygenはソースファイル内に次の形式で書かれたコメントより ドキュメントを作成する．
  • コードのドキュメント付け
    • 「/**」と「*/」 で囲まれたコメント文
    • 「/// 」ではじまるコメント行

      
            /**
                 これはDoxygenがドキュメントとして解釈するコメントです．
                 複数の行にわたって記述することができます．
            */
      
            ///  これはドキュメントとして解釈されるコメント行です．
      
      

  • ドキュメントとして有効なコメント内に，次のコマンドを書き入れると その部分は特別な意味を持つと解釈される
  • 主なコマンド

    @author	著者
    @date	日付
    @brief	要約
    @bug	バグについての記述
    @param	関数の引数についての記述
    @return	戻り値についての記述
    @section	セクション名
    @subsection	サブセクション名
    @subsubsection	サブサブセクション名
    @paragraph	パラグラフ名
    @em	イタリック体
    @n	改行
    @image	画像	[使用方法] @image  html  file名

    @は\記号で置き換えることもできる

学科< 研究室< 授業