📝
Doxygenでドキュメント自動生成
仕様書を明日までに100ページかけるかな？
「出来らあっ！」
といってしまったときに使うのがDoxygenです（嘘です）。
ソースコードから自動でドキュメントを生成してくれます。たまに色々な事情で使いたくなるのですが、使い方いつも忘れてしまうのでメモしておきます。
セットアップ
Mac
Homebrewをインストールした前提です。以下コマンドでOKです。
$ brew install doxygen
$ brew install graphviz
Linux/Windows(WSL2)
Linux（というかUbuntu）だと以下です。
$ sudo apt update
$ sudo apt install -y graphviz
$ sudo apt install -y doxygen
使い方
ドキュメントを生成したいソースコードに移動して、Doxygenのセットアップファイルを新規作成します。
$ doxygen -g Doxyfile
参考リンクのサイトとかを参考に、いい感じに修正したDoxyfileをGistにアップロードしました。そちらを使う場合は、上記コマンドの代わりに以下実行してください。
$ wget https://gist.githubusercontent.com/karaage0703/31d7be40796ad58f205120d707daacaf/raw/e31dffbbf326790e47b95e64aa340371dc240734/Doxyfile
設定ファイルを作成したら、ドキュメントを自動生成しましょう。Doxyfileがあるディレクトリで以下実行してください。
$ doxygen Doxyfile
Doxygen使用例
Open Interpreterで試してみた例です。それっぽいドキュメントが生成されます。
まとめ
Doxygenの使い方です。ちなみに、Doxygenで作ったドキュメント、あんまり活用できた記憶はないです。ソースコード読めると、あんまりソースコードみるのと変わらない気がしますし、逆にソースコード読めない人は、Doxygenで自動生成したドキュメントを読んでも「いや、これがあっても」みたいになる気がします。
一番の活用例は、ドキュメント作りの時間稼ぎだったり？するかもしれません。
いい感じのドキュメントの自動生成は、そのうちAIがいい感じにやってくれるようになるんじゃないかなと思います。
参考リンク
Discussion