语法突出显示RDoc文件中的Ruby代码？

Question

我正在记录我正在编写的Ruby库。在我的README.rdoc文件中，我提供了一些使用一些演示Ruby代码的例子。

但是，生成的HTML文档不会显示带有语法突出显示的Ruby代码，而只是作为一个代码块。

当我查看例如http://rdoc.rubyforge.org/README_rdoc.html，我看到的只是一段Ruby代码，就像我在README.rdoc中包含的一样。是否有传递给rdoc命令的特殊选项？

Answer 1

RDoc，有点天真，使用下面的方法来确定它是否可以使用语法高亮显示。

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

因此，只有包含以下字符串之一的代码才会突出显示：

• DEF
• 类
• 模块
• 需要
• =＆GT;
• {|
• 做|

Answer 2

您必须使用包含语法突出显示的RDoc模板。网上有许多浮动。

（我同意Phrogz，你应该使用YARD以及Markdown语法。）