シリコンバレー ２４時

« 2006年12月19日

メイン

2006年12月21日 »

2006年12月20日

RD (Ruby Document)

Ruby関連の情報をいろいろ調べていると、「RD」という言葉に遭遇することが多々ある。 では、「RD」とは、一体 何のことなのか。

まず、私が一番はじめに「RD」という言葉に遭遇したのは Rubyの「コメント」について調査した時。 以前のブログ 「Ruby の コメント（１）」 でも書いたとおり、Rubyのコメントには二通りあって、 行コメント としての「＃」 と ブロックコメントの「=begin 〜 =end」。 しかし、このブロックコメントの方は、マニュアル上 コメントとは呼ばずに 「埋め込みドキュメント」 と呼んでいる。 その「=begin 〜 =end」についての説明部分を引用させていただくと。

Rubyのソースコードにドキュメントを埋め込む事ができます。 文が始まる部分の行頭の =begin から、 =end で始まる行までが埋め込みドキュメントです。 Rubyインタプリタとしては内容に縛りはかけませんが、 通常はRD形式でドキュメントを埋め込むことを期待しています。

とある。ここで「RD形式」という表現が使われている。

では、Ruby リファレンスマニュアル 「RD」 ページでの説明は、というと、ここでの説明は一行だけ。

このリファレンスマニュアルでも使われているドキュメント形式です。

あとは、関連記事へのリンクである。

いろいろリンクを辿ってみると、 「RD とは POD のようなドキュメントフォーマットである」という記述があった。 ここで言う「POD」とは何であろう。 ご存知の通り、RubyはPerlの影響を強く受けている。 そのPerlのドキュメントの基本形が 「POD(Plain Old Document)」である。 「RD」とは、このPerlの「POD」を参考にし ドキュメント形式を Ruby風にアレンジしたもののようだ。

RDの文法は POD にも似ているが Wikiにも似ていてる。 例を挙げると 「= で始まる行はタイトルになる。」 「周辺より字下げが深い箇所はそのまま出力」 「箇条書きは行頭が * で始まっている行で表す」 というようになっている。 文法について詳しくは 「RD working draft 日本語版」 に解説してある。

また文法が Wikiに似ているということから、 このRDの文法そのままで Wikiしてしまうという 「Rwiki」 というアプリケーションも存在している。

それから RDフォーマットのファイルからhtml 等の フォーマットへ変換するアプリケーションが 「RDtool」だ。 このRDtoolは、残念ながらRubyのシステムにデフォルトでは組み込まれていないようだ。

【参考リンク】

• Ruby リファレンスマニュアル
• Ruby リファレンスマニュアル「埋め込みドキュメント」
• Ruby リファレンスマニュアル「RD」
• RD working draft 日本語版
• Rwiki 公式サイト
• RDtool
• Wikipedia「Plain Old Documentation」
• Perlドキュメントの読み方

カテゴリー: Ruby     22:44 | コメント (0) | トラックバック (0)

« 2006年12月19日

メイン

2006年12月21日 »