Подсветка синтаксиса кода Ruby в файле RDoc?

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
• класс
• модуль
• требуется
• =>
• {|
• делать |

Answer 2

Вы должны использовать шаблон RDoc, который включает подсветку синтаксиса.В Интернете много плавающих.

(я согласен с Phrogz, вам следует использовать YARD, а также синтаксис Markdown.)