ruby-list

Toshです。

In message "[ruby-list:24481] Re: RubyDocumentationProject(仮)"
    on 00/08/25, Tadayoshi Funaba <tadf@kt.rim.or.jp> writes:
>JCA02266> ふぅ、やっぱそうなります？何が悪いんだろう？

RDなんてドキュメントらしきものはToshが適当にでっちあげたrd-draft.rd
くらいしかないし、山のように交わされたメールで議論してる少数の人と
そうでない人の間で広がるギャップ、って感じじゃないですかねぇ。
bladeでいまさら読むにも量が多すぎるし。

>JCA02266> 参照する気がないなら「書かないといけない」ことはないです。
>
>ちょっと話がズレてる気がしますが、メソッドリストはそんな寛大さは持ちあ
>わせていない、ということでよいですか。クラス名は省けない、というべきで
>しょうか。そして、別段メソッドリストは使わなくてもいいんですね。

結局はRDなんて各人が好きに書けばいいんじゃないですか。別にHTMLみたい
に厳密な文章構造を定義しているってわけでもないですし。

RDPみたいなもので集まったRDがてんでばらばらだとカッコつきませんけど。


MethodListについてはなんか誤解があるようなのでまとめ。

リファレンスみたいなもの書く時の選択肢は大きく分けて3つ。

  (1) MethodListを使い、標準的な(?)書き方に従う。
  (2) MethodListを使い、標準的な書き方でない書き方をする。
  (3) MethodListは使わない。(でDescListを使う)
      (1) パラメタを書く。
      (2) パラメタを書かない。

他にもあるとはおもいますが。

標準的な書き方というのはRDを処理するプログラムが処理できる形式
です。

(2)にあるように、別にクラス名は省略できない、とかそういうことは
ありません。

あと、僕はちょっと前に「MethodList使わないのは不可能」とか言って
ますがそれは僕の判断ではそうだという意味です。理由はこのメール
を読んでいけばわかると思います。たぶん。

MethodListを使う事でどんなご利益があるか、使わないとどんな不都合
があるかを説明します。

(3)の場合を考えます。

(3-1)では(例えば)次の様にメソッドを書くでしょう。

  : Foo#bar(x, y)

これを参照したい時には((<Foo#bar(x, y)>))と書く事になります。
HTMLなどに変換した時にパラメタリストがうざいので、
((<Foo#bar|Foo#bar(x, y)>))と書きたくなるかも知れません。
これだと、RDを読む時や書く時にはさらにうざったくなりますね。
しかも、パラメタの名前は便宜上のもので、それ自体には意味は
無いのに、参照の時にそれらも正確に書く必要があります。大変だ。

(3-2)はしょうがないので、パラメタは省略する事にした場合です。
つまり、
  
  : Foo#bar

みたいにした時です。でもこれだとパラメタの説明がなくなって
しまいます。それではリファレンスとしては不便になります。

さらに、上ではあえて省略したのですが、記述にきちんと意味を
与えようとすると

  : (({Foo#bar(((|x|)), ((|y|)))}))

とかなります。こうなるともはや解読不可能。でも、こうしないと
HTMLにしたときにFooとかが固定幅にならないのでなんか気になり
ますよね。

MethodListというのは、「じゃあ参照の時だけパラメタリストを
省略できるようにしましょう」というものです。
基本的にはただそれだけです。どうやって実現しているかと言うと
単に「「(」「{」以下はラベルにしない。」ってことにしている
だけです。

だから、クラス名を省略するのは別にしちゃいけないわけじゃない
けど、クラス名を省略すると場合によってはラベルが衝突します。
あと、

  --- self <=> other

みたいな書き方をすると参照の時に((<self <=> other>))と書かない
とフォーマッタが処理できません。

それと、MethodListを使えばフォーマッタがそれがメソッドであると
理解できるので、Inline無しにCODEとかのついたHTMLが吐けます。
ただし、きちんとそれをやるにはメソッドの書式を解析する必要が
あるので、標準的な書き方でないMethodListを書くと間違ったHTML
になってしまうかも。

(2)の場合について。フォーマッタが対応している書き方であれば
(1)とまったく同様の恩恵を受けられるはず。そうでないから、
標準的な書き方というものが推奨されているのです。
「標準的な書き方」っていうのはMethodListの文法には含まれて
いません。一応。

MethodListは見切り発車で今の形に決まったものなので、仕様の
変更は容易と思われます。それに、メソッドの書き方の決まりは
いくつか種類があってもいいんじゃないでしょうか。

以上。

メソッドインデクスとかについてがやたら議論されたのが誤解のもと
なんじゃないかと思ったので、あれはすっぱり切捨てました。

ぜんぜん「まとめ」になりませんでした。すみません。(^^;;

>メソッドリストは RD の他の要素とかなり違ってみえます。RD には、クラス
>を表現する特別な構造はありません。スーパークラスを記述するための特別な
>構文もありません。メソッドリストだけが特殊のように思えます。

クラスは別に普通にDescListとかで書いてもほとんど何の問題も起きないから
です。

>メソッドリストの考えに従えば、メソッド以外の要素についても構文が用意さ
>れていて、おかしくないと思います。そういう構造があれば、いちいちクラス
>名を書く必要はなくなるかもしれません (メソッドリストも含めて、それらは 
>RD と馴染まないかもしれないし、RD でなくてもいいのですが)。僕はメソッ
>ドリストのやりかたは中途半端に感じてしまうのですが、RD な人達はまた違
>う考えがあるのでしょうね。そこが聞きたいです。

「メソッドのための特別な構文が必要である」って理念にしたがって作られた
のなら「クラスのためのも必要」ってことになるんですが、単に上に挙げた
問題の対症療法ってのが存在理由なので。

と僕は思ってます。

>JCA02266> ＃ 議論しちゃった。こうやってだらだらと書くから敬遠される？

# 俺のメール、半分くらいまで読んで嫌になる人続出と予想。

---
Tosh
Toshiro Kuwabara

Thread

Prev Next

In This Thread

Prev Next

[#24065] Perl/Ruby Conference in Kyoto — Noritsugu Nakamura <nnakamur@...>

[#24068] continuation in thread — Takaaki Tateishi <ttate@...>

[#24070] 謎の Segmentation fault — YASUI Kentarow <kenyasui@...>

[#24073] Ruby で使える XML パーザーについて — Takaharu Yamashita <takayan@...2.so-net.ne.jp>

[#24082] Array#assoc — Kazuhiro NISHIYAMA <zn@...>

[#24086] // は偽？ — rubikitch <rubikitch@...>

[#24088] mod_ruby-0.1.8 and postgres-0.6.1 — Teruki Shigitani <shigi@...>

[#24095] p <obj> の返値 — ARIMA Yasuhiro <fit0298@...>

[#24102] Perl/Ruby Conference 開催決定 ! — matz@... (Yukihiro Matsumoto)

[#24109] gtk+ なクラスブラウザ — kadu <kadu3@...16.alpha-net.ne.jp>

[#24112] ある method がどこで def されたか調べる方法 — Yasushi Shoji <yashi@...>

[#24123] CGI::pretty — Kazuhiro NISHIYAMA <zn@...>

[#24125] rbcw145.zip に lib/net/telnet.rb がない — Kazuhiro NISHIYAMA <zn@...>

[#24126] embedded Ruby for Verilog — "Kikutani, Makoto" <kikutani@...>

[#24134] File.rename error message — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#24149] methods — Kazuhiro NISHIYAMA <zn@...>

[#24156] 改行コードが… — Hagemu Higuchi <hahiguc@...11.odn.ne.jp>

[#24158] Hash の初期値に [] を使う — Mitsuhiro Kondo <kondo@...>

[#24174] ruby によるバグ追跡システム — 堀川 久 <vzw00011@...>

[#24176] FreeBSD ports — "Akinori -Aki- MUSHA" <knu@...>

[#24186] media watch 2000.08.08 — Noritsugu Nakamura <nnakamur@...>

[#24191] drb.rb: 0x40155740 is recycled object (IndexError) — Hideto ISHIBASHI <hideto-i@...4u.or.jp>

[#24193] FreeBSD ports #2 — "Akinori -Aki- MUSHA" <knu@...>

[#24195] HTML 関連ライブラリ — MoonWolf <moonwolf@...>

[#24206] iconv 0.4.2 pre3 — nobu.nakada@...

[#24210] install guide — gotoken@... (GOTO Kentaro)

[#24222] FreeBSD ports #3 — "Akinori -Aki- MUSHA" <knu@...>

[#24226] Ruby で日本語とスペイン語の混在文は？ — Kakuzi TAKAHASI <ktaka@...>

[#24230] Ruby 1.4.6 repacked — matz@...

[#24249] no oper in %Ruby — Shugo Maeda <shugo@...>

[#24250] コマンドの STDERR への出力を補足したい。 — Kengo Nakajima <ringo@...>

[#24255] DBM failed on cygwin version — Ataru NAKATA <anakata@...>

[#24257] デバッグ用にデータをダンプしたい — Mitsuhiro Kondo <kondo@...>

[#24259] RDindex 1.1.0 — rubikitch <rubikitch@...>

[#24261] — Shigeki Shiroshima <pakshima@...>

[#24267] What's the biggest Ruby development? — Dave Thomas <Dave@...>

[#24268] はじめまして & cygwinでconfigure不能 — "Mitsuo Igarashi" <mitsu5@...>

[#24270] 1.4.6 cgi-lib — Masatoshi SEKI <m_seki@...>

[#24271] Tiki, ruby-1.4.6 — Masatoshi SEKI <m_seki@...>

[#24272] How to read buffered data? — Tanaka Akira <akr@...17n.org>

[#24274] About sub with multilines — kiri@...

[#24280] RE: [ruby-list:24268] cygwinでconfigure不能:cygwin1.dllの問題 — "Mitsuo Igarashi" <mitsu5@...>

[#24284] 拡張ライブラリ作成時の NULL ポインター — Akimichi Tatsukawa <akimichi@...>

[#24291] media watch 2000.08.18 — Noritsugu Nakamura <nnakamur@...>

[#24294] grep(!/hoge/)? — kiri@...

[#24298] Re: cygwin で configure 不能 :cygwin1.dll の問題 — "Mitsuo Igarashi" <mitsu5@...>

[#24299] Where MDArray? — kiri@...

[#24305] Status: header and cgi.rb — Yasuhiro Fukuma <yasuf@...>

[#24314] はじめまして ...? — polygon <kiyose@...>

[#24316] 画像のサイズを調べるスクリプト — kadu <kadu3@...16.alpha-net.ne.jp>

[#24317] undefined cygwin_dll_entry — polygon <kiyose@...>

[#24321] shttpsrv — TAKAHASHI Masayoshi <maki@...>

[#24323] HP-UX 上での ruby1.4.6 make getaddrinfo.c err — yasuaki onishi <yasuaki@...4u.or.jp>

[#24324] ruby の発展の為に — "Mitsuo Igarashi" <mitsu5@...>

[#24329] Coerce between Range and Boolean — NISHIKAWA <nyasu@...3web.ne.jp>

[#24341] install guide draft — gotoken@... (GOTO Kentaro)

[#24357] FreeBSD ports #4 — "Akinori -Aki- MUSHA" <knu@...>

[#24378] bin package on win/dos — Noritsugu Nakamura <nnakamur@...>

[#24384] erb-1.3.1 — Masatoshi SEKI <m_seki@...>

[#24399] 「 Ruby プログラミング入門」査読者募集 — Shin-ichiro Hara <sinara@...>

[#24430] (RDP) Engurish ftools.rd — gotoken@... (GOTO Kentaro)

[#24439] HotLinks — NISHIKAWA <nyasu@...3web.ne.jp>

[#24447] (RDP) tempfile.rd — Toshiro Kuwabara <toshirok@...3.so-net.ne.jp>

[#24464] Tips for Perl -> Ruby — kiri@...

[#24469] レンタルサーバで eruby — Tokita Kousui <ktokita@...>

[#24473] RD for(?) Cygwin — polygon <kiyose@...>

[#24491] Re: レンタルサーバで eruby — "Kahori Takeuchi" <EB89012@...>

[#24499] FreeBSD port: x11-toolkits/rubytk — Yasuhiro Fukuma <yasuf@...>

[#24501] media watch 2000.08.24 — Noritsugu Nakamura <nnakamur@...>

[#24515] MSWin Ruby on Windows2000 — arton <arton@...>

[#24520] wildcard arg for ruby1.4 — arton <arton@...>

[#24522] (RDP) readline — Koji Arai <JCA02266@...>

[#24531] RD 質問 — Koji Arai <JCA02266@...>

[#24550] Array への nil の代入について — Kenya Ogata <k_ogata@...>

[#24556] 埋め込みドキュメント仕様 RubyDoc( 提案) — MoonWolf <moonwolf@...>

[#24559] 配列内のオブジェクトの配列内のオブジェクトの関数 — Yasuki <yasuki@...>

[#24565] Ruby FAQ — Kazuhiro NISHIYAMA <zn@...>

[#24592] perl to ruby — "Yasuyuki Imai" <waver@...3.ttcn.ne.jp>

[#24625] member list was crashed — matz@... (Yukihiro Matsumoto)

[#24631] Re: RubyDocumentationProject( 仮 ) — TAKAHASHI Masayoshi <maki@...>

[#24174] ruby によるバグ追跡システム — 堀川　久 <vzw00011@...>