構文ハイライトRDocファイルのRubyコード？

Question

私が書いているRubyライブラリを文書化しています。私のREADME.rdocファイルでは、いくつかのデモRubyコードの使用例を紹介しています。

しかし、結果として得られるHTMLドキュメントには、構文ブロックが強調表示されたRubyコードは表示されず、単なるコードブロックとして表示されます。

たとえば、 http://rdoc.rubyforge.org/README_rdoc.html、私が見ているのは、README.rdocに含まれているように、Rubyコードです。 rdocコマンドに渡す特別なオプションはありますか？

Answer 1

構文ハイライトを含むRDocテンプレートを使用する必要があります。ウェブの周りには多くの浮動小数点があります。

（私はPhrogzに同意する、あなたはYARDともマークダウン構文を使用する必要があります。）

Answer 2

のRDocは、やや単純に、それはシンタックスハイライトを使用することができるかどうかを判断するには、以下の方法を使用しています。

def parseable? text 
    text =~ /\b(def|class|module|require) |=>|\{\s?\||do \|/ and 
     text !~ /<%|%>/ 
    end 

それが次のいずれかの文字列を含んでいるのであれば、あなたのコードのみが強調表示されます：

• デフ
• クラス
• モジュール
• は
• =>
• が必要です{|
• do |