はなちるのマイノート

Unityをメインとした技術ブログ。自分らしくまったりやっていきたいと思いますー!

【Unity,c#】Doxygenを使ってプロジェクトのドキュメントを自動生成する

はじめに

今回はDoxygenというツールを使って以下の画像のようなドキュメントを生成してみたいと思います。

f:id:hanaaaaaachiru:20211019222240p:plain
ドキュメント例

Doxygenをインストールする

まずはDoxygenをインストールします。
www.doxygen.nl

f:id:hanaaaaaachiru:20211019171116p:plain
Mac用のインストーラーをダウンロードする

私の場合はMac用のインストーラーを入れました。

GUIツールの概要

無事インストールできるとDoxygen GUI frontendが入っているはずなので、起動をしてください。

f:id:hanaaaaaachiru:20211019202029p:plain
Doxygen GUI frontend


それぞれの設定は以下の画像の通りになります。

f:id:hanaaaaaachiru:20211019212429p:plain
Projectの設定
f:id:hanaaaaaachiru:20211019215028p:plain
Modeの設定
f:id:hanaaaaaachiru:20211019215359p:plain
Outputの設定
f:id:hanaaaaaachiru:20211019215632p:plain
Diagramsの設定


基本は指示通りに入れればOKですが、Unityで使う場合は以下の箇所に注意してくみてください。

  • Project : Scan recursivelyにチェック
  • Mode : Optimize for Java or C# Output
  • Diagrams : GraphVizを使う場合は事前にインストールしておいてください

生成する

あとはRun doxygenをクリックすればOKです。

f:id:hanaaaaaachiru:20211019220849p:plain
Run doxygen

無事に生成ができれば、以下のようなHTML(設定したファイル形式)が出力されるはずです。

f:id:hanaaaaaachiru:20211019222240p:plain
ドキュメント例

さいごに

解析するフォルダを複数指定・除外する方法も書いたので、Unityで外部から導入したいなんて場合には役に立つかもしれません。

www.hanachiru-blog.com