C/C++ だとおそらくスタンダードな Doxygen について簡単にまとめてみました。
一応 C# なんかもいけますが、C# だと DocFX
とかのほうがトレンドっぽいですね。
以下、Windows 版の前提です。
インストール
以下のサイトからダウンロードできます。
インストールは普通に行えば OK です。
設定方法
Doxygen は CUI が基本ですが、一応 GUI の設定ツールとして Doxywizard が付属しています。
Doxywizard での設定方法
Doxywizard で作成した設定はファイルとして保存できます。(デフォルトのファイル名は Doxygen)
「Step 1」の working directory に相対パスを指定した場合、次回 Doxygen ファイルを読み込んだときには絶対パスで表示されるようです。
まずは Project で以下を設定します。
Source code directory
で入力となるソースがあるフォルダを指定します。Destination directory
で HTML や Latex の出力先のフォルダを指定します。
言語を指定します。
出力に関する設定を行います。
ダイアグラムに関する設定を行います。 Graphviz がインストールされていれば Graphviz を使用することでより詳細なダイアグラムを作成できます。
実行
Run タブから Run doxygen
をクリックします。