ruby-list

Toshです。

In message "[ruby-list:18472] Re: Array doesn't include Comparable"
    on 99/11/10, EGUCHI Osamu <eguchi@shizuokanet.ne.jp> writes:

>そういや、ruby-info.elのポインタを示してなかった。
>  <ftp://ftp.netlab.co.jp/pub/lang/ruby/contrib/ruby-info.el>
>です。[ruby-list:14304]から始まるスレッドを見てもらってもよ
>いです。＞興味を持った人

とりあえず、ruby-texi-1.4と、ruby-info.elをとってきて、試して
みました。
なるほど、たしかにruby-info.elは便利そうです。リファレンスを
調べるのにEmacsの中でできるし、操作も簡単だし。

>> 要はメソッド索引が簡単にできればいいわけですから、RDの仕様に
>> 盛り込む事まで考えなくても、メソッド索引付きのRDの作成を支援
>> するツールとか、rd/rd2html-mindex.rbの様な方向で進めても、目的
>> は果たせそうですね。
>
>率直な意見としては、Headline 等に #, :: を含むかどうかでの判
>断って言うのは多少無理があるかなぁと思います。つまり、RDの仕
>様として盛り込んだ方が綺麗だろうと言うのが私の考え。ただまぁ、
>あまりRDを書いてない人間がごちゃごちゃ言うのも変なので、とり
>あえず戯言として受け取ってもらっても構いません。
>
>要求は利用者からのものの方が良いでしょうし、rd2html-mindex.rb
>は、そのための叩き台としては十分だと思うので、私から言うこと
>は(今のところ)これ以上ありません。

ruby-texi-1.4とTexinfo自体のinfoの@defmethodのトコあたりをちょっと
覗いて見てようやく理解しました。今までは僕はちょっと誤解していたと
思います。
あらいさんが要求していたのは"@findex"のようなものだと思っていたの
ですが、そうでなくて"@defmethod"相当が欲しいってことですよね？

確かにTexinfoのようなものを見ると"@defmethod"相当はあったほうがいい
のかも、と思えてきます。それが自然かも、と。

RDはこれまでのところ、plain text + 文章構造 みたいな感じに仕様が
決められて来ました。それに対して、Texinfoのアプローチは意味領域に
まで踏み込んで人間の意図をコンピュータに伝えようとしているように
見えます。
そのため、Texinfoにはリファレンスみたいなものを書く時に細かい指定
ができるようなコマンドがたくさんあるみたいですね。"@defmethod"と
"@deffn"は別になってたりもしますし。

さて、Texinfoのアプローチは魅力的ですが、Texinfoのようにたくさんの
コマンドを仕様に含む訳にはいかないRD((- RDは読みやすく書きやすいが
モットーなので、なるべくコンパクトに文法をまとめたいのです。-))に
はTexinfoを追っかけるのは無理があります、たぶん。
それじゃあ、どこまでTexinfoのイイトコを取り込むか？

とりあえず、リファレンス的なものはたくさん書かれるだろう、というのは
ほぼわかってるので、ここらへんの部分はなんとかしたいところです。

それで、ぱっと思い付く限りではやりかたは2通り。
 (1) リファレンスみたいなものは、きっとRubyのリファレンスマニュアルと
     だいたい同じ形式で書かれるだろうと仮定します。つまり、あるクラス
     についてのリファレンスの文章構造が、
       = Foo (クラス名)
       クラスについての説明。
       == Class Methods
       === new 
       説明。
       ...
       === Instance Methods
       === hogehoge
       説明。
       ...
     こんな感じになるであろうと仮定して、この形式に沿った文章構造の
     ドキュメントならば、メソッド索引などの付加情報も抽出できるという
     方法。
 (2) メソッド宣言用の専用Headlineの文法を新しく定義する。

1番目のやり方は間接的で、ドキュメントの書き方に制約をつけます。もっとも、
この形式で書かなくてはいけないと言う訳ではありません。恩恵は得られなくなり
ますが。
2番目のやりかたは直接的で単純ですが、問題もあります。定数((-なんか名前も
変わっちゃうみたいですが。-))・クラスメソッド・インスタンスメソッド・
クラス(さらにもしかしたら、モジュールとモジュール関数については別にすべき？)
について別々の文法を用意しなきゃならないので、文法を決めるのがまず
結構大変です。わかりやすく、覚えやすくて、見ためも美しくないとならないので。
それと、文法に組み込むと後で変更ができない、もしくは難しいってのもいや
なところですね。

さて、どうしたらいいでしょうか？

---
Tosh
Toshiro Kuwabara

Thread

Prev Next

In This Thread

Prev Next

[#18226] Ruby 本ってば、うれしいなー — Atsuko Yoshida <atsuko@...>

[#18229] [book-bug]p.270,273,305 — "ISIHARA HIROSI" <ishihara-h@...>

[#18233] [book] blade.nagaokaut.ac.jp/ruby/ruby-list/ — Shin-ichiro Hara <sinara@...>

[#18235] [book-bug] p.261 — YOKOYAMA Takehiro <tac@...>

[#18236] Ruby AP 展示会出展 — Yoshida Masato <yoshidam@...>

[#18242] Re: i++ に見る性格の差 — toyofuku@...

[#18247] [book bug] 82, 186 — KIMURA Koichi <kbk@...>

[#18252] http-access.rb で state != :META — SETSURA <setsura@...>

[#18265] アクセス制御について — Tadashige Morii <m_tada@...>

[#18279] [book bug] p.557 — kenn@...

[#18293] [book] 新宿紀伊國屋売り上げ情報 — Noritsugu Nakamura <nnakamur@...>

[#18303] Float#step が欲しい・・・ — 伊藤 友裕 <j6398015@...>

[#18307] Re: <=> — Toyofuku <toyofuku@...>

[#18308] DRb|drb|druby + iterator — Masatoshi SEKI <m_seki@...>

[#18310] Re: 変数、代入 — "Takehiko Ueki" <takehiko@...>

[#18327] [book][]= メソッド — Noritsugu Nakamura <nnakamur@...>

[#18332] rubyTk の Tk は何がお勧めですか？ — Sakae Kobayashi <sakae@...>

[#18338] オブジェクトの非同一性判定 — Ayanosuke <aya@...>

[#18341] [book] missing prec.c — Minero Aoki <aamine@...>

[#18345] jsort — Koretsugu Daigoro <tmmcross@...>

[#18347] Re: <=> — Toyofuku <toyofuku@...>

[#18348] Is there ext/GD for gd-1.7.x — "OGAWA, Hiroshi Santa" <santa@...>

[#18354] Re: <=> — Toyofuku <toyofuku@...>

[#18356] [book] gets — KANEKO Naoshi <wbs01621@...>

[#18361] Proc in a loop — ttate@...

[#18371] [book] IO/Enumerable — Tadayoshi Funaba <tadf@...>

[#18374] regular pattern — Katsuya Tanaka <tanaka@...>

[#18375] コマンドラインベースの電卓 — Kouichi Isobe <isobe@...>

[#18402] bug of regexp and book errata — Yoshiki Wada <wada@...>

[#18404] ruby-1.4.2 for NetBSD/alpha — SHIROYAMA Takayuki <psi@...>

[#18406] ruby 1.4.2 for NeXTSTEP — SHIROYAMA Takayuki <psi@...>

[#18408] [BUG] debug.rb(?) — Chikanaga Tomoyuki <hekitou@...>

[#18413] document writer — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#18417] Re: document writer — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#18420] bindrv on oracle — 中村暁史 Nakamura Akifumi <BXQ04723@...>

[#18422] ruby-1.4.2-2.{i386,src}.rpm — Naoki Kawakami <knao@...>

[#18425] joke (Re: [ruby-dev:8247] Re: 例外を処理する 2 項演算子) — gotoken@... (GOTO Kentaro)

[#18429] ビット演算について — Tadashige Morii <m_tada@...>

[#18432] [GTK] signal_connect_after — gotoken@... (GOTO Kentaro)

[#18442] Re: <=> — toyofuku@...

[#18443] ruby とベンチマーク — Noritsugu Nakamura <nnakamur@...>

[#18447] mswin32 でのファイル名の大 / 小文字 — "U.Nakamura" <usa@...>

[#18451] [book-bug]p89 http get — KANEKO Naoshi <wbs01621@...>

[#18467] Array doesn't include Comparable — kjana@... (YANAGAWA Kazuhisa)

[#18469] rbdoc-0.0.3 — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#18471] SMF class — Tadayoshi Funaba <tadf@...>

[#18474] オープンソースまつり — matz@... (Yukihiro Matsumoto)

[#18475] Re: オープンソースまつり — KIMURA Koichi <kbk@...>

[#18476] paramclass — gotoken@... (GOTO Kentaro)

[#18477] [book] csv_split — Kazuhiro Nishiyama <nishiyama@...1.tiki.ne.jp>

[#18478] [book] p.255 — とみたまさひろ <tommy@...>

[#18479] ruby 1.4.2 can't compile ?? — ゆうたん☆ <yu-tan@...>

[#18480] ruby 1.4.2 can't compile ?? — ゆうたん☆ <yu-tan@...>

[#18485] Linux magazine 12/1999 — WATANABE Tetsuya <tetsu@...>

[#18490] [CFV] icompetition — gotoken@... (GOTO Kentaro)

[#18494] `make test' failure on Cygwin build w/ --enable-shared — Mimpei MORISHITA <mimpei@...>

[#18501] 関数 ` の動作 — Keisuke CHIBA <chiba@...>

[#18502] TMail bug report — Shugo Maeda <shugo@...>

[#18517] 自分の IP を獲得する方法 — Suguru Kakishita <kakky@...>

[#18521] Is there errata? — Mimpei MORISHITA <mimpei@...>

[#18526] アイコンコンテスト（ファイル用） — Hoshino Hitoshi <zin@...>

[#18529] [book] — Toyofuku <toyofuku@...>

[#18533] cover animal for Ruby book — Koretsugu Daigoro <tmmcross@...>

[#18536] How to upload file*s* — Toyofuku <toyofuku@...>

[#18539] [book] $*, etc. — Yasuhiro Fukuma <yasuf@...>

[#18541] Ruby/*PDF* — kinneko <ydate@...>

[#18542] clone of Gtk+ widget — Takayuki YAMAGUCHI <tyamaguchi@...>

[#18544] Readline.readline and signal trap — Chikanaga Tomoyuki <chikanaga@...>

[#18545] 変数の型チェック — "Hideaki Takata" <hideakit@...3.dion.ne.jp>

[#18555] EUC to JIS by Kconv — nosuzuki@... (Norio Suzuki)

[#18560] [book] p.190 — とみたまさひろ <tommy@...>

[#18570] RubyUnit — Masaki Suketa<CQN02273@...>

[#18576] Re: ruby-1.4.2 NeXT Port — SHIROYAMA Takayuki <psi@...>

[#18580] — tokoma@... (中川 誠)

[#18582] Regexp source — Kazuhiro Nishiyama <nishiyama@...1.tiki.ne.jp>

[#18583] Re: How to upload file*s* — Toyofuku <toyofuku@...>

[#18584] [REQ] [].grep(pat) #=> [] — gotoken@... (GOTO Kentaro)

[#18589] icompetition closed — gotoken@... (GOTO Kentaro)

[#18603] coding style — Shugo Maeda <shugo@...>

[#18608] swigruby-0.3 — Masaki Fukushima <fukusima@...>

[#18303] Float#step が欲しい・・・ — 伊藤　友裕 <j6398015@...>

[#18536] How to upload files — Toyofuku <toyofuku@...>

[#18541] Ruby/PDF — kinneko <ydate@...>

[#18580] — tokoma@... (中川誠)

[#18583] Re: How to upload files — Toyofuku <toyofuku@...>

[#18664] Re: ruby から SQL Server — たむら　けんいち<ken-ichi.tamura@...>

[#18807] protected なメソッドの再定義 — YAMASHITA Junji (山下純司) <ys_jyunji@...>