ruby-list

Toshです。

In message "[ruby-list:20042] Re: RD with method index (again)"
    on 00/01/04, nobu.nakada@nifty.ne.jp <nobu.nakada@nifty.ne.jp> writes:
>  private メソッドのドキュメントは =begin private とか、(私は)
>RD として処理されないようにラベルを付けてたりしますが、こういうの
>はどうなるんでしょうね。隠しドキュメント(undocumented document)と
>か? (^^)

それは全然問題ありません。たぶん典型的なやりかたの一つになるんじゃない
かと思います。

>> >  どうせなら、上に書いたように =begin RD 以外でも <<< が有効にな
>> >るようにしていただけるとありがたいのですが…。
>> 
>> これは人によって欲しい人と欲しくない人がいると思いますので、欲しい人は
>> 御自分で"<<<"を解釈するfilterを書くのがいいかと思います。
>> filter自体がそもそもそういう目的で作られたものですので。
>
>  そうしたいのですが、include_path とかが現状では filter からは見
>えないというのがありまして。

なるほど。
ではinclude_pathはfilterから見えるようにしましょう。

>  あと <<< というのが =begin, =end と同レベルの扱い、つまり RD と
>か filter とかよりも以前というか下位レイヤーでの処理かと思ってま
>した、なんとなく。

処理の都合上、RDのIncludeについては前処理の段階で扱ってますが、本来は
RDの機能の一つです。もっとも便宜上Blockってことになっていますが、例外
的なものではあります。

filterはRDの枠の中には入りません、と言うよりRDの枠の中に入らないものを
扱う為の仕組みです。"=begin" ... "=end"というのはRDの一部とも言えますが
中に何が入っているかはRubyインタプリタも見てませんし、RDの下層と言える
と思います。

>> コマンドラインオプションでの指定はかなり前から考えてはいるのですが、
>> コマンドラインオプションで指定していると長くなっちゃうんじゃないかなぁ、
>> とか、共通のオプションとフォーマットライブラリ依存のオプションをフロント
>> エンドはどう区別してどうやってフォーマットライブラリに渡すのか、とかで
>> 悩んでいて決まらないのでほっておいてる状態です。
>
>  これは、ライブラリの必要とするオプションはライブラリをロードす
>るまで分からないからとか、そういう意味でしょうか。optparse を調べ
>てみたら、途中でオプションを追加してもちゃんと動くようです。こう
>いう使い方は当初想定してなかったんですが。宣伝みたいで(っていうか
>そのもの?)恐縮ですが、こいつじゃ役に立ちませんか。

理由はだいたいそういう事です。

optparseですが、そのやり方だとARGFちゃんと扱えますか？
元々getoptには限界を感じていたのでoptparseの採用は検討します。ただ
この手のライブラリはいくつもあるようなので、色々と調べてみてからに
したいですね。

>> >  近頃、自作のツールとかでもドキュメントを書かねばならん、みたい
>> >な強迫観念的なものに駆られてるらしくて(笑)。
>> 
>> それはいいことじゃないですか。(^^)
>
>  昨日いじってた optparse だとだいたい 1/3 くらいがドキュメントだ
>という(^^;。

やっぱりドキュメント重要だと思うのですよ。とくにライブラリは。
RDtoolのパーサ書く時にいくつかあるパーサジェネレータの中からRacc
選んだのもきちんとしたドキュメントがあったのが要因ですし。
ドキュメントがあると、なんかこまめにメンテナンスされてるように
見えるので、安心して使えますからね。

---
Tosh
Toshiro Kuwabara

Thread

Prev Next

In This Thread

Prev Next

[#19998] benchmark.rb — gotoken@... (GOTO Kentaro)

[#20003] REQ: String#gsub — Tomoyuki Kosimizu <greentea@...2.so-net.ne.jp>

[#20018] ruby-1.4.3.tar.gz の日付 — Tadashige Morii <m_tada@...>

[#20028] xmltree — "Masatoshi SEKI" <m_seki@...>

[#20035] DocBook 4.0: ClassSynopsis — Yasushi Shoji <yashi@...>

[#20041] Re: xmltree — "Masatoshi SEKI" <m_seki@...>

[#20046] 1/0 — "Shigeo Kobayashi" <shigeo@...>

[#20053] == === case — "Shigeo Kobayashi" <shigeo@...>

[#20057] mirror.rb in Ruby Book — Takashi SATO <turmite@...>

[#20059] 改行がリダイレクトされない ruby1.4.3cygwin? — 中村暁史 Nakamura Akifumi <BXQ04723@...>

[#20077] Range expansion? — Akinori MUSHA aka knu <knu@...>

[#20083] non-block IO with TCPSocket — dn <daisuke@...>

[#20087] Re: a instance of Struct subclass on the block parameter (Re: Range expansion?) — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#20097] Re: [REQ] ruby-math (Re: coerce) — Toyofuku <toyofuku@...>

[#20118] media watch 2000.01.08 — Noritsugu Nakamura <nnakamur@...>

[#20120] タブの出力について — 鮎川夏生 <natuki@...>

[#20123] TMail and Racc and RDtool — Masaki Suketa<CQN02273@...>

[#20131] String to Time — Yukihiko Eda <yuki-e@...>

[#20133] おききしたーいでーす — akimaru <akimaru@...>

[#20145] BUG? Parse Error and and — Tomoyuki Kosimizu <greentea@...2.so-net.ne.jp>

[#20150] Ruby BUG ?? — Sakae Kobayashi <sakae@...>

[#20162] proxy ftp — "Kikutani, Makoto" <kikutani@...>

[#20174] Ruby-book erratum — "K.Kodama" <kdm@...>

[#20175] class Polynomial — "K.Kodama" <kdm@...>

[#20176] Re: Complex#divmod — Masato KIYAMA <masato@...>

[#20178] [Gtk 0.22] Gtk::DrawingArea cannot pack in Gtk::VBox — h-isikaw@...

[#20184] [book] 付録 A — Kazuhiro Nishiyama <nishiyama@...1.tiki.ne.jp>

[#20185] [book] 8,9,10 章 — Kazuhiro Nishiyama <nishiyama@...1.tiki.ne.jp>

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

[#20187] Hash#index, Hash#indexes — Kazuhiro Nishiyama <nishiyama@...1.tiki.ne.jp>

[#20188] slashdot - The 2000 Beanies — Yasushi Shoji <yashi@...>

[#20191] thread について — Yasushi Abe (阿部靖司) <yasushi@...>

[#20192] timeout.rb の Thread.abort_on_exception = true — Matsuo Hisanori <hisanori@...>

[#20203] Gtk::ItemFactory の代替品を作ってみました — dellin <ogu@...>

[#20210] Ruby 強調表示定義ファイル for 秀丸 — Ayanosuke <aya@...>

[#20211] %Ruby — Shugo Maeda <shugo@...>

[#20215] racc debianized — akira yamada / やまだあきら <akira@...>

[#20219] catching exceptions in rb_eval_string() — OZAWA Sakuro <crouton@...>

[#20221] while TRUE と loop の違いを教えてください — Sakae Kobayashi <sakae@...>

[#20235] simple-chat-server.rb don't work on lynx — M_HANA <M_HANA@...0.sapporo-soft.ac.jp>

[#20237] Ruby/Tk multi interpreter — nagai@...

[#20240] eRuby banner — OZAWA Sakuro <crouton@...>

[#20243] (rd2) nl in Japanese chars — gotoken@... (GOTO Kentaro)

[#20246] Q: Singleton Class and Singleton Method — Tomoyuki Kosimizu <greentea@...2.so-net.ne.jp>

[#20249] FTP.open err for Windows95 — "Y Kataoka" <kataoka@...>

[#20274] RAA script — akira yamada / やまだあきら <akira@...>

[#20279] [ 雑談 ] メーリングリスト抜けますです〜 — Atsuko Yoshida <atsuko@...>

[#20284] ruby と論文と知名度 — Noritsugu Nakamura <nnakamur@...>

[#20300] net/http.rb — TAKAHASHI Masayoshi <maki@...>

[#20301] notify_observers in observer.rb — Matsuo Hisanori <hisanori@...>

[#20310] ワイルドカード有りのファイルの存在を調べたいのですが — 関口久之 <sekiguci@...>

[#20318] gtk: how to copy clist item into clipboard. — OZAWA Sakuro <crouton@...>

[#20320] TMail is too strict? — Shugo Maeda <shugo@...>

[#20337] — Norihito Shinzan <kabbalah@...>

[#20339] Telnet (login failed) — Kentaro Inagaki / 稲垣 健太郎 <inagaki@...>

[#20341] ftp.ruby-lang.org ([book][CD-ROM]README.txt) — SUGIHARA Hiroshi <maili31s@...>

[#20342] How to build ruby(current) with cygwin — KORIYAMA Naohiro <kory@...2.so-net.ne.jp>

[#20344] E-mail アドレスの確認・ DNS の MX など — ogino@...

[#20348] Ruby/LAPACK working group — gotoken@... (GOTO Kentaro)

[#20349] パスワードの crypt とチェック — Ayanosuke <aya@...>

[#20350] [PATCH] Ruby/Tk — Koji Arai <JCA02266@...>

[#20355] personal web server(win98) で ruby の cgi を実行したい — Hiroshi Saito <HiroshiSaito@...>

[#20363] media watch 2000.01.24 — Noritsugu Nakamura <nnakamur@...>

[#20369] divmod() — Yasushi Abe <yasushi@...>

[#20385] Re: class Polynomial — Toyofuku <toyofuku@...>

[#20393] eRuby で掲示板作ってみました — Noriyuki Okamoto <okamoto@...>

[#20394] ruby-1.4.3 port to HPUX 11.00 — matz@... (Yukihiro Matsumoto)

[#20400] Ruby win Icon — たむら けんいち<ken-ichi.tamura@...>

[#20409] Ruby/Gtk のバージョンを取得したい — dellin <ogu@...>

[#20413] File::open() マニュアル — とみたまさひろ <tommy@...>

[#20414] 3 桁毎にカンマを入れる — 堀川 久 <vzw00011@...>

[#20433] クラスメソッド呼び出しの parse error — Yoshiki Wada <wada@...>

[#20438] cygwin 版 Ruby での BLT 利用について — otokita@...

[#20445] Anquete for Object Day 2000 — Tomoyuki Kosimizu <greentea@...2.so-net.ne.jp>

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

Thread

In This Thread

[#20339] Telnet (login failed) — Kentaro Inagaki / 稲垣健太郎 <inagaki@...>

[#20400] Ruby win Icon — たむら　けんいち<ken-ichi.tamura@...>

[#20414] 3 桁毎にカンマを入れる — 堀川　久 <vzw00011@...>