テストコードにはWhat、ソースコードにはHow、ドキュメントにはWhyを書くべきについて
http://d.hatena.ne.jp/babie/20060611/p2
だとすると、RDocの各メソッドの説明はテストコード側に書く方がより自然であるといったことをどこかのページで見てこれにも共感した。
ということでやってみようかなと思いRDocのライブラリのソースを少し漁ってみたけれどRDoc行数が長くて非常にムズイ…。i
rdoc/parser/parse_test_rb.rbとかいったやつを書いてしまえばよいのかな…。
ちなみにtestコードを読んだ方が具体例が出てくるのでソースを読むより効果的と言われているけれど、test/unitのソースは非常に文字が詰まっていて見づらいと自分は感じてしまう。まぁ慣れの問題なのだろうけれど、rdoc/parser/parse_test_rb.rbではassert_*なメソッドが読みやすいように整形されて、
# this is hoge. def test_hoge assert_equal expected, actual, msg end
が
とかいった感じになればすごく良さそうな気がします。ちなみにRDocの記述方法そのものをあまり把握していないというのは秘密。