ドキュメント - malibu-bulldogの日記

を読んで。

Doxygenで作られているページを覗いてみた。感想は「いやぁ〜しっかり書いてるなぁー」です。
すばらしい。
僕なんか一応プロなんだけど結構いいかげんだったりしてて。。。すんません関係者各位。
（仕事は僕以外の開発者も何人かいて，みな僕が作ったAPIを呼び出したりする）

ちなみに仕事場で，id:etopirika5さんが言及しているDoxygenも使っているけどそれに加えてWikiをやっている。
APIやクラスの説明はDoxygenで十分。

しかし問題は設計思想。
「○○は省メモリを意識しているのでこういう使い方してください」
みたいな。
こういうのを伝えないと，結構思いもよらない使い方されたりする。
（最悪な場合は後で大問題になり作り直しとか発生してしまうことも。。。）

まぁ設計思想そのものをソースに反映できれば最高なんだけど…なかなかソースだけ見て設計思想がわかるようなのを作るのは大変というか自分に無理っちゅうか。

あとWikiを使うのは，Doxygenだけだとどうしても数式とか絵とかをドキュメントに追加するのが大変になってしまうってのもある。
ここらへん簡単にDoxygenに組み込めるとすてきなんだけど，実はそういう機能がDoxygenにあるのかなぁ〜？

結論として，来年頭ぐらいに仕事場のドキュメントを再整備したいと思う。（変な結論だ。。。）