これまでJavaの開発を長くしてきたので重宝したのがJavadoc、サクッとドキュメントを作るのに大変便利だった。研究開発的な部署にいたのでお客様向けドキュメントはあまり書かず、レビューする相手も居なかったのでjavadoc以上の設計書のようなドキュメントはあまり書いてこなかった。ER図だって会社に入ったころに1回くらいしか書いてない。たま～に気が向いたら、概説書的なドキュメントを書いた。どんなソフトか、何ができるかを書きとめたもので、ソフトの設計書というよりは、これは気持ちを書き綴ったものだから読書感想文にちかい。
でもそんな僕にもその時がきた。ソフト設計書的なドキュメントを取り纏めなければならない日が。
そう、転職である。転職するために、これまで作りためてきたものを遂に引き継ぐ時が来たのだ。
前述のように一人でやってるもんだから、作るべきものができた場合、ドキュメントは書かずに、適当にインターフェースを書いて、まず最初は習作となる実装を作っていく。そしてだいたい出来上がったところで全体を見回してあまりにも酷いようなら、実装を変えてみたり、最悪もう一度ゼロから書き直してみたりする。svvitchもそうやって、一度習作を作ってから、インターフェースを見直す段階でまたゼロから作り直してみた。そして今のコードになってるわけだけど、そんなわけで今のところドキュメントはない。
c++のドキュメントをリバースエンジで作れないか探してみたところ、Doxygen+Graphvizでクラス図を自動生成する というのがみつかった。これが結構いい感じなのだ。
だいたいこのサイトの通りに、GraphvizとDoxygenを入れてドキュメントを作ってみたところ、クラス図的なものも入るし、javadoc形式のコメント文でもいいようなのでjavaの時と同じようにコメントを入れておけばいい様子。Doxygenすご～い。Javadocもドックレットとか面白いけど、Doxygenもいいなぁ。そんなわけで間もなくsvvitchにもドキュメントができますw
コメント