From: Hiroshi Igarashi <igarashi@...>
Date: 1998-11-01T03:37:15+09:00
Subject: [ruby-list:10549] Re: 引数の数 (Re: 大規模プログラムの友)

いがらしです。

From: m_seki@mva.biglobe.ne.jp (SEKI)
Subject: [ruby-list:10542] Re: 引数の数 (Re: 大規模プログラムの友)

> 実はこんな質問した理由は他にもあって、
> モジュールやクラスのリファレンスマニュアルのひな型を
> ruby に書かせられないかなぁ と考えていました。

これはマニュアルの対象となるモジュールなどを含むスクリプトを
実際にloadして、メソッドなどの情報を集めるということですよね。

さらにスクリプトを簡単に解析して、
埋め込みドキュメント
=begin
...
=end
の中の情報も使って、ひな型ではないちゃんとしたものが
できたら、なお嬉しいです。

ただそうするとloadと自前の解析とで、二度手間のような
気もします。どちらかだけでドキュメント生成に充分な情報が
得られればいいのですが。

> # 完成予想図 (foo.rbを読んだときのクラスFooのリファレンスを出力)
> # % rb2html.rb -script foo.rb Foo > foo.html    

私も、このところいじっているXML形式のドキュメントは
手書きだけでなく、何らかのツールにより埋め込み
ドキュメントから自動生成することを考えていました。
埋め込みドキュメントの方が実装とドキュメントの乖離が
小さくなるだろうという理由からです。
＃でもそんなに埋め込みドキュメントにこだわる必要はないのかな？

また最終的な形式はHTMLやInfoなど様々考えられますが、
そこまでの変換の中間形式としてSGMLやXMLあたりが
よいのではと考えています。直接HTMLとかを吐いても
いいのですが、SGMLなどを経由した方が出力のカスタマイズが
楽だと思うので。

---------------
いがらし ひろし