如何在RDoc文件中语法高亮Ruby代码？

Question

我正在记录我编写的Ruby库。在我的README.rdoc文件中，我包含了一个带有一些演示Ruby代码的使用示例。

然而，生成的HTML文档并没有显示带有语法突出显示的Ruby代码，只是一个代码块。

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

- mydoghasworms

---

你用什么工具来生成文档？你使用 YARD 吗？ - Phrogz

不，只有随分发的rdoc版本：--version = rdoc1.9.1 2.5.8 - mydoghasworms

Answer 1

RDoc有点天真地使用以下方法来确定是否可以使用语法高亮器。

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

如果您的代码包含以下字符串之一，它将被突出显示：

• def
• class
• module
• require
• =>
• { |
• do |

- sdsykes

Answer 2

您必须使用包含语法高亮的RDoc模板。在网上有很多这样的模板。

(我同意Phrogz的观点，您应该使用YARD和Markdown语法。)

- gioele