From: Toshiro Kuwabara <toshirok@...3.so-net.ne.jp>
Date: 2000-06-15T00:08:44+09:00
Subject: [ruby-list:23257] Re: readablity of RD

Toshです。

In message "[ruby-list:23248] Re: readablity of RD"
    on 00/06/14, TAKAHASHI Masayoshi <maki@inac.co.jp> writes:
>Toshiro Kuwabara <toshirok@yb3.so-net.ne.jp>さん：
>> そもそも、Emacs + ruby-modeで書いている時には色が違うのでどこがRDなの
>> かすぐわかるのですが、そうでない時はRDとスクリプトの境界は見えづらい
>> という問題もあります。
>
>色がつかないと苦しいです。はい。

これは結構悩ましいですよね。

>> でもこの書き方なかなか便利なのですよ。最近はメソッドを書く時には
>> 対応するMethodListをとりあえず書いてしまう、というような書き方を
>> しています。説明文は面倒なら省略してしまってもよくて、これだけでも
>> 自分の定義したクラスのMethod一覧がHTMLですぐに出せるので、引数の
>> 順番とかを忘れた時、とかになかなか便利なのです。
>
>うーん、わたしはやっぱり「RDはテキストでこそ」という気持ち
>なので、HTMLで便利でもplain text時に見づらいのは許容できない
>のです。

いや、RDそのまま読んでもいいのですが、今RubyスクリプトからRDだけを
抜きだして来るスクリプトがないので、ドキュメント抽出するのにHTMLに
変換しちまうのが手っ取り早いってだけのことです。そうすれば、リンク
もたどれるし。
僕のやりたいのは、「メソッドのインターフェイスだけを見たい」ってこと
なので、読むのはRDだろうがHTMLだろうが。Cでのヘッダファイルの代わりで
すね。

上のはスクリプトとRDを交互に書くやり方を弁護しただけで、別にスクリプト
とRDが見分けづらいことを正当化したわけではないですよん。

  =begin RD ----------------------
  == module AutoLabel
  ....
  =end ---------------------------

  module AutoLabel

とでも書けば見やすくなりますかねぇ？

---
Tosh
Toshiro Kuwabara