プログラムのコメントからクラス図等のリファレンスを作成するDoxygenの導入

ソフトウェア開発で広く使用されているドキュメント生成ツール「Doxygen」の公式サイトからインストーラをダウンロードして、インストール、 GUI 版の Doxywizard を起動する手順を紹介します。

Doxygen は、ソースコードのコメントから HTML や PDF 形式のドキュメントを生成できるので、ドキュメントを作成するコストを軽減できます。

※ Doxygen 1.12.0 を使用します。

Doxygen とは
グラフ画像を生成する Graphviz の導入
インストーラのダウンロード
インストール
起動
まとめ
参照サイト Thank You!

Doxygen とは

Doxygen は、ソフトウェア開発で広く使用されているドキュメント生成ツールです。
ソースコードのコメントからドキュメントを生成して、HTML や PDF などの形式で出力できます。

Doxygen is a widely-used documentation generator tool in software development. It automates the generation of documentation from source code comments, parsing information about classes, functions, and variables to produce output in formats like HTML and PDF. By simplifying and standardizing the documentation process, Doxygen enhances collaboration and maintenance across diverse programming languages and project scales.

Doxygen は、ソフトウェア開発で広く使用されているドキュメント生成ツールです。ソースコードコメントからのドキュメントの生成を自動化し、クラス、関数、変数に関する情報を解析して HTML や PDF などの形式で出力を生成します。 Doxygen は、文書化プロセスを簡素化し標準化することで、さまざまなプログラミング言語やプロジェクト規模にわたるコラボレーションとメンテナンスを強化します。
Doxygen homepage と Google 翻訳

グラフ画像を生成する Graphviz の導入

今回は、 Doxygen, Graphviz の順番でインストールしますが、 Graphviz を先にインストールしておくと、 Doxygen が自動的に Graphviz を認識して、クラス図などのグラフ画像を描画する Dot 機能を設定しなくても有効にしてくれるかもしれません。

Graphviz のインストールについては以下の記事を参照してください。