読者です 読者をやめる 読者になる 読者になる

Life, Education, Death

プログラミング以外でも思ったことをつらつらと書きたい

Doxygenを使ってみた

Doxygenはメジャーなドキュメント生成ツール。
C++、C、JavaObjective-CPythonなどに対応していて、JavaDoc風のコメントからでも生成できるのがありがたい。


Javaなんかは別にJavaDocを純粋に使ったらいいと思うのだけども、C++とかだと結構面倒。

加えてJavaDoc以外にうまく書式が決まっていていいコメントの書き方ってものを知らないので、とてもうれしい。

インストール

Windowsなら公式サイトにインストーラーがあるので簡単にインストールできる。継承関係の図などを描画するためにgraphvizというライブラリを使っているのでこれも一緒にインストールすると幸せになれる。

設定

インストールが終了するとスタートメニューにDoxygenGUIツールがインストールされているのでそれを使う。
WizardとExpertがあるので、好きな方で設定する。

Wizardの使い方はここにある。英語でわかりづらいときはそれぞれの項目の意味をこっちで調べながらやるといいと思う。


最低限XXX_GRAPHとかなってる項目をチェックするといい。


次に設定ファイルの保存が必要。場所はどうも日本語ではないところがいいようなので、自分の作っているプロジェクトのディレクトリにでも設置すればいいだろう。


その次がワーキングディレクトリの設定?よくわかってないけど、適当に設定;;;


そして、Startをクリックするとガンガン生成を始める。生成されたらボタンの下の出力を見てエラーを出していないか見たほうが念のためいいと思う。

ハマった

一部図が出ないところがあって、それを解決するにはSHORT_NAMEを有効にするといいようだ。GUIではProjectのタブの下のほうにある。

最後に

ドキュメントを生成できるようなコメントの書き方をしっかり体に染み込ませるようにしないといけないなぁと思う。

加えて、図を見ているとおかしな継承関係じゃないか?とか考えるのにいいと思った。