RDoci18n

Rubyのドキュメント生成ソフトであるRDocに対するパッチです。

Rubyソースに複数の言語によるドキュメントを記述しておき、ドキュメント生成の際に使用する言語を指定できるようにします。

1.8.6-p36用

• rdoc_i18n_1.8.6-p36.patch

1.8.5用

• rdoc_i18n_1.8.5.patch

ドキュメントの記述方法

Rubyソースにドキュメントを記述する際に、

lang: ja

などのようにして言語を指定します。ひとかたまりのコメントの中で、指定した行以降がその言語で記述されていると見なされます。

ドキュメントの記述例

行頭に`#'を書く場合

#!/usr/bin/ruby

# Sample for i18n RDoc
# lang: ja
# RDoc 多言語化対応のためのサンプル

# Sample class
# lang: ja
# サンプルクラス
class Test
   # Print out `hoge'
   # lang: ja
   # 「ほげ」を出力
   def hoge
      puts "hoge"
   end
end

`==begin'と`==end'で囲む場合

#!/usr/bin/ruby
=begin rdoc
Sample for <tt>=begin ... =end</tt>
lang: ja
<tt>=begin ... =end</tt> 形式のためのサンプル
=end

=begin rdoc
Sample class 2
lang: ja
サンプル用クラスその2
=end
class Test2
=begin rdoc
output `fuga'
lang: ja
「ふが」を出力
=end
   def fuga
      puts "fuga"
   end
end

RDocの実行方法

--lang | -l

ドキュメントとして使用する言語を指定します。

ここで指定した言語で記述されたコメントと、言語指定されていないコメントがドキュメントとして出力されます。

--lang-strict

言語指定されていないコメントの扱いを変更します。

使用する言語を--langや-lで指定した場合

言語指定されていないコメントを出力しません

使用する言語を--langや-lで指定しなかった場合

言語指定されていないコメントだけをドキュメントとして出力します。