[ruby-list:19961] Re: RD with method index (again)

新井です。

>>> From: Toshiro Kuwabara <[e-mail]>
>>> Date: 28 Dec 1999 12:59:04 +0900
>>> Subject: [ruby-list:19949] Re: RD with method index (again)

> Toshです。

> "---"ってのはInfoの表示からですかね？

そうかも知れません。意識したつもりはなかったのですが。

> 個人的に見ためは好きですが、
>  --- Class#method
>        description about Class#method.
> インデントが深くなりがち。

そうですね。私もこの点は気にしてます。

> メソッド用のDescList自体に反対する理由は特に無いですが、以前ちょっと話
> していた「Rubyのリファレンスマニュアルと同様の形式のRDに対してフォーマッ
> タががんばって解析する」って案は白紙にしちゃってよいのでしょうか？

私はそのつもり。フォーマット決めても簡単に波状するだろうとい
う結論に達しました(そういう経験をしたわけではなく想像で)。

> >|  演算子形式のメソッド:
> >|                        --- Class#[]=(arg1, arg2)
> >|                        --- Class#+(arg)
> >
> >rd2htmlはラベルにできる文字に制約があったように思うのでなん
> >らかの変換が必要ですね。
> 
> えっと、どうだったかな？
> 「HTMLのアンカーに使えない文字がある」ってことならば、回避する為に
> アンカーは"label:num"みたいな形になっています。
> # ラベルが日本語だとやっぱりアンカーにできませんし。
> BASE64のような(BASE64そのままは確か使えませんが)変換をすることも
> 考えましたが、いろいろ思うところあって今の形に。

確か、/ は特別扱いすることになりませんでした？
   --- Integer#/(other)

     ((<Integer#"/">))

ruby-talk読み違えたかな？

> よく考えて見たところ、WHITELINEとBLANKLINEが区別されてる理由は
> 「歴史的理由」だったみたいです。(^^;;
> 古いバージョンのRDtoolが採用していたルールだとListの後ろに
> Verbatimを置く時などにそうする必要があったんじゃないかと。
> 修正は簡単なので、直します。

えっと今後WHITELINEが必要なのはVerbatimだけってことになりま
す？それはうれしい。

> RDにコメントがあってもドキュメントの内容に関するメモを残すぐらいにしか
> 使わないので。
> 内容に関するメモは読み手が見れてもいいんじゃないかと思うのです。

undocumented な記述(なんか矛盾してる^^;)を忘れないようとりあ
えず書いておきたい。ってのはありえるかなと思いました。でそう
いうのってメソッドでありそうですよね。ちょっと追加したから名
前だけ

### --- method

って書いておきたいとか。ないかな？。まぁコメントの件はとりあ
えず保留でもいいです。現状でコメントが不可能なわけではないの
だし。

--
新井康司 (Koji Arai)