高橋征義です。

keiju / ishitsuka.com (石塚圭樹) wrote:
> >最近PHPを使い始めてて、PHPDoc(JavaDocもどき)がわりといい感じ
> >だったので、Rubyでもこういう感じに書けるといいかなあ、と
> >思って、それっぽいものを少し書いているのでした。
> 
> RDってそういうものかと思っていたのですが, そうでもないのかな?

これなんですが、いくつかのライブラリ(xmlparserとか)に
RDでメソッドについての簡単なコメントを書いてみた経験から
言うと、特に数行程度の短いコメントの場合、RDだと読みにくく
なってしまいがちみたいなんですよ。

RDの場合、単体のドキュメントにするか、ソース内に含めるなら、
前または後ろにまとめてつけるのようなタイプの書き方をする
べきなのではないか、というのが暫定的な結論です。
例えば、リファレンスマニュアルやRDPはRDに向いているけど、
作成中のソースに都度コメントを書くなら、RDよりもJavaDoc
もどきの方が向いているかも、と。逆に、そこからRDのメソッド
リファレンス形式のドキュメントを生成して、plain textとしては
それを配布することにする、なんてのもありかなと思います。

まあでも、この辺は個人的な見解なんで、異論のある人もいる
とは思います。はい。

> >というか、任意の式をメソッド引数のデフォルト値として書かれると
> >parseするのは辛すぎますね……「禁止禁止」というわけにもあんまり
> >いかないでしょうし。やっぱり引数はまじめにparseしない方が
> >幸せへの道かも。
> 
> でしょうね. それだけのためにRubyのパーザ作ることになってしまう(^^;;;

Daveの結論もそうだったみたいで、RiR待ちだそうです。
でも、どーせ型情報もないんだし、まじめにparseできたところで
Javaなどに比べればあまりメリットないかもしれませんよね。
だったら、文字列で十分か、と。

> ## でも, 今ちょっと立て込んでいるので、もうちょっと待ってください.

私もしばらく立て込んでいるので、他に困っている方がいなければ
いつでも構いません :-)

高橋征義 (TAKAHASHI Masayoshi)   E-mail: maki / open-news.com