Doxygenの使い方まとめ

doxygenの使い方について紹介します。

Doxygenの概要とメリット

Doxygen(http://www.doxygen.jp/) とは、専用の記法でコメントを書くことで、自動でドキュメントを作成することができ、GNU General Public Licenseで配布されています。
自作ライブラリを公開している場合は、とても便利です。

主な特徴

1. 多くのファイル形式（HTML、LATEX、Wordなど）でドキュメントを出力できる。
2. 多くの言語に対応している（C++，C，Java，Objective-C，Python，IDL (Corba,Microsoft風)，Fortran，VHDL，PHP，C#など）。Pythonには専用のPydocがあるが、Doxygenの記法ならマルチで使用できる。
3. ソースコードを解析するので一貫性が保たれる。
4. 内包・依存図，継承図，およびコラボレーション図により視覚化することができる。
5. 昔からあり、ユーザーも比較的多いため、今後も継続的に利用できる可能性が高い。

基本的な使い方

• 環境構築
  • MacにDoxygenをインストールする方法
  • UbuntuにDoxygenをインストールする方法
• 基本操作
  • 設定ファイルの作成〜ドキュメント作成までの流れ
• プログラミング言語別
  • Pythonのコメント記述例

関連ページ

【Zabbix入門】基本的な使い方から応用例まで徹底解説

Zabbixとは？使い方やインストール方法について紹介します。

algorithm.joho.info

2023.10.04

ラズベリーパイの使い方と応用例

ラズベリーパイ4・5の使い方や応用例について入門者向けにまとめてみました。

algorithm.joho.info

2017.04.13