最終更新:2017-11-17 (金) 11:38:22 (4d)  

Doxygen はてなブックマークを見る
Top / Doxygen

www.doxygen.org/

http://www.doxygen.jp/

Doxygen は、C++C言語Objective-CC♯PHP、[Java、[Python]]、IDL (Corba、Microsoft 風) 向けのドキュメンテーション・システムです。 D言語 にもある程度対応しています。

利点

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

GUI

  • ワーキングディレクトリ:出力先
    Project nameプロジェクト名。ドキュメントのタイトルなど様々な場所に反映される。
    Project synopsisプロジェクト概要。出力形式が HTML の場合、タイトル直下に説明文として添えられる。
    Project version or idプロジェクトのバージョン情報、または識別子。出力形式が HTML の場合、タイトル右側に添えられる。
    Source code directory解析対象とするソースコードを格納したフォルダの場所。相対パスも指定できる。
    Scan recursivelyチェックしないとサブフォルダを見に行かない

メモ

  • エンコーディング:UTF-8
  • 出力:デフォルトだとHTMLLaTeX

関連