masaki-fの日記： るびぃめもその1

あれはもう4年以上まえ、インフラ系大手I社で働いていたときのことでした(学生だったので派遣扱いだったけど)。僕はNさんに「プログラム説明書書いといてぇー」といわれたのです。そこでもうブチキレですよ(今思うと)。まぁプログラム説明書つってもいろいろですが、そのとき要求されたのは関数の使い方(それはCのコードだった)とか引数の説明とかの一覧だったのでした(成果物としてクライアントに提出用+微妙に引き継ぎ用)。そんなもん、ソースを見ろと。なんのためにいちいち関数の先頭に説明書いてあるんだと。

あぁ懐かしい。

まぁ自分本位なドキュメントしかかけなかったわたくしは見るも耐えないドキュメントを書いて、ソースからコピペしまくってとりあえず書き上げたわけですが、僕はそれ以来埋め込みドキュメントツールを手放せない人になったわけで、C/C++だったら絶対doxygenです。フリーの中ではダントツ好みかなぁ。graphvizと組み合わせてコラボレーション図を書いてくれるのがお茶目。

JavaだとやっぱりJavadocなんですが、たまにdoxygenも使ったり使わなかったり。っていうかもうJava忘れました（ぉ

PHPはPHPDocとか使ってましたが、ぶっちゃけイマイチ、と。

で、rubyで気合いれてコーディングするにあたって何かイイ感じのツールがないかなー、と探してたわけですが(まぁあるにはいろいろある)とりあえず

RDoc

でいってみようかな、と思います。サンプル見るとなかなか楽しい出力みたいですしね。

あとはアレだ。RDで別ファイルのラベルに対してさくっとリンクを生成する方法って無いのかな、と考え中。みんな困ってないのかなー。ちょい作ってみようかな？