SDKのドキュメントを制作中です。

現在、ToyStudioのプラグインSDKのドキュメントを制作中です。

ソフトウェア ライブラリのドキュメント制作には膨大な手間がかかる場合が多く、何らかの自動化ツールを利用しないと、バージョンアップやバグフィックスに際してのメインテナンスが困難になります。

ピエールは今回、Doxygenというドキュメント制作ツールを使っています。以前少しだけ使ってみたことがあるのですが、今回は色々と実験しながら使い込んでいます。

ドキュメントに独自のHTMLページを追加することができ、自動生成されたページとのリンクも可能で、非常によくできたツールです。ソフトウェアの世界では、優れたツールを利用することで何十人分の仕事が一人で出来てしまうことがたびたびあります。Doxygenはまさにその典型と言える優秀なツールだと思います。

コメントを残す

メールアドレスが公開されることはありません。