[ruby-list:23275] Re: readablity of RD

Toshです。

In message "[ruby-list:23271] Re: readablity of RD"
    on 00/06/15, Kenya Ogata <[e-mail]> writes:
>ひとつは、=bigin のあとに付加された = によって示される深さ
>を、その begin-end 間で基準にする案で
>
>=begin
>==Class Test
>===Method Boo
>
>と
>
>=begin =
>=Class Test
>==Method Boo
>
>を等価にみなすものです。

えっと、とりあえず、Headlineの書き方ですが、"="のあとは空白をひとつ
以上置いてください。

  == Class Test

ってかんじに。

>あと、気持ち悪く感じる原因によるとおもうのですが、
>default で発生するのが問題であれば、
>
>=begin Class caption==
>このクラスの説明です。

上の両方に共通する問題ですが、"=begin", "=end"にはRDの内側と外側を分け
る境界以上の意味は持たせたくない、というのが僕の意見です。
理由は単純にわかりづらくなりそうだから。

それと、例えば1番目のやりかただと、Headlineだけを見てもレベルがわから
ないことになるので、これはRDとしては可読性を失う事になるのです。
プログラムにとっては"=begin"の後ろに付いた"="の数を覚えておくのは造作も
ないことですが、人間には結構大変な仕事です。

なんか見出しのようなGlobalでドキュメント構造に直接関わって来る重要な
要素にあまり自由度を持たせると文法が複雑になるように思えます。
例えば2番目の例で書かれたRDと普通に書いたRDでは同じフォーマットには
見えなくなってしまうんじゃないかと。

>でも、やっぱり内容が異ってしまいます。8^^;
>やっぱりむずかしいですね。

「ええ、難しいのですよ。」って書くとまつもとさんみたい？(^^;;

---
Tosh
Toshiro Kuwabara