お薦め ページ

メニュー

ハワイ島 遊覧飛行ツアー

ハワイ島 Ｂ＆Ｂ・ホテル

ハワイ島 不動産情報

ハワイ島 情報・観光ガイド

ブログ(Blog)

その他

関連サイト

: 個別エントリー・アーカイブ :

« RD (Ruby Document) メイン RI コマンド »

2006年12月21日

RDoc

昨日のブログで「RD (Ruby Document)」について書いたが、 Rubyの世界でのドキュメントに関しては、もうひとつ 「RDoc」というものもあるようだ。

RDoc については 「RDoc による自動ドキュメント生成」 に わかりやすく解説してある。 このページによると 「Ruby Documentation System (RDoc) とは, Ruby で書かれたソースコードからドキュメントを自動生成する, Ruby 本体に付属する標準ライブラリの1つです.」 とある。 これだけを読むと、RDとどこが違うのだろうか、と思ってしまう。

また、RDocのコマンドそのものについては 「RDOC - Ruby Documentation System」 に、また、その日本語訳として 「大林一平さんによるRDoc日本語訳」 に詳しく説明してある。 そのはじめの部分に
RdocとはRubyのソースファイルに対するドキュメントを生成するアプリケーションです。 JavaDocと同様に、ソースを解析し、クラス、モジュール、メソッドの定義を抜き出してきます
とある。 昨日のブログで取り上げた 「RD」が Perlの「POD(Plain Old Document)」を参考にしているのに対し、 こちらの「RDoc」は Javaの 「JavaDoc」 を 参考にした仕様になっており、 ソースコードを解析し、クラス、モジュール、メソッドの定義を抜き出して ドキュメントを生成してくれるようだ。

さらに、この RDocの書式については 「RDoc 覚え書き」 にも詳しく解説してある。

結局、上記のようなサイトを調査してみると、 RD と RDoc は 似て非なるもののようだ。 とくに RDocの方は Rubyのソースコードから、 クラス、モジュール、メソッドの定義を抜き出し、 それらの内容の直前に書かれたコメントはそのクラス等の説明である という前提でドキュメント化を行う。 また文法も若干異なるが、RDocの方が 簡単になっている。 そして RDocコマンドは、Rubyシステムに標準で添付されているコマンドである。

【参考リンク】

カテゴリー: Ruby     2006年12月21日 22:56

トラックバック

このエントリーのトラックバックURL:
http://www.skymerica.com/blog/yotsumoto/mt/mt-tb.cgi/655


コメント

コメントしてください




保存しますか?


 
ハワイ島での遊覧飛行ツアーとＢ＆Ｂのスペシャリスト、スカイメリカ
Copyright © 2003,2009 Skymerica Corp. All rights reserved.