2008年2月22日

[ruby-list:44684] Re: RDoc,RDフォーマットの公式文書はどこにあるのでしょうか

 小西 弘将です。

丁寧なご返事、ありがとうございます。

>斎藤と申します。
>
>RDocについてのみですが、
>

>On Fri, 22 Feb 2008 11:15:37 +0900
>konishih@xxxxx wrote:
>
>> RDoc自体のドキュメントは配布されているRuby自身についているのでしょうか?
>
>はい。「仕様書」と呼ぶべきかどうかはともかくとして、Ruby自身の配布ファイル
>の中に"lib/rdocs/README"というのが含まれています。公式のドキュメントの中で
>は、これが一番良く書かれたものだと思います。
あ、ソースコード側にあるんですね。こっちは見ていませんでした。いつも
mswin32バイナリ配布版を使っているのですが、バイナリ配布パッケージや、イ
ンストール後の構成には入らないとは思いませんでした。

>それがHTMLに成形された物はここで見られます。
>
> http://www.ruby-doc.org/core/classes/RDoc.html
こういうサイトがあるんですね。ちなみにこのサイトはRubyコミュニティとして
公式な意味合いを持つと考えてよいのでしょうか?


>…と、ぱっと見で分かるかもしれませんが、この公式READMEを翻訳した物が
>
>> RDocについては
>> http://www.kmc.gr.jp/~ohai/rdoc.ja.html
>
>のようですね。
>
>ちなみに、標準添付される前の(結構)古い公式サイトがここです。
>
> http://rdoc.sourceforge.net/
>
>短いながらも、RDocとRD(RDtool)を比較した文書があります。
>
>"RDtool or RDoc?"
> http://rdoc.sourceforge.net/rd/
>
>--
>斎藤ただし

インストール後のlib以下を読んでいて思ったのですが、コメントの形式がRDoc
とRDの両方使われていますね。
別に両方とも可読性が良いので問題ないかもしれませんが、現在HTMLなどへの
パーサが標準添付されているのがRDocのみであることを考えると、この辺は統一
した方がよいような気がします。
まあ、いつものことですが誰がやるのと言われれば言葉に窮しますが。

RDocについては、インストール後も見られる場所にあったり、ruby-lang.orgか
らたどれるとありがたいのですが。どうでしょうか?

#〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜
# 小西 弘将 ( KONISHI Hiromasa )
# konishih@xxxxx
#〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜〜

投稿者 xml-rpc : 2008年2月22日 18:04
役に立ちました?:
過去のフィードバック 平均:(0) 総合:(0) 投票回数:(0)
本記事へのTrackback: http://hoop.euqset.org/blog/mt-tb2006.cgi/70205
トラックバック
コメント
コメントする




画像の中に見える文字を入力してください。