Я документирую библиотеку Ruby, которую пишу. В моем файле README.rdoc я включил пример использования с некоторым демонстрационным кодом Ruby.
Однако полученная HTML-документация не показывает код Ruby с подсветкой синтаксиса, а просто блок кода.
Когда я смотрю на источник, например. http://rdoc.rubyforge.org/README_rdoc.html, я вижу только кусок Код Ruby, такой же, как я включил в свой README.rdoc. Есть ли специальный вариант для перехода к команде rdoc?
Вы должны использовать шаблон RDoc, который включает подсветку синтаксиса. Их много в сети.
(Я согласен с Phrogz, вы должны использовать YARD, а также синтаксис Markdown.)
RDoc несколько наивно использует описанный ниже метод, чтобы определить, может ли он использовать подсветку синтаксиса.
def parseable? text
text =~ /\b(def|class|module|require) |=>|\{\s?\||do \|/ and
text !~ /<%|%>/
end
Таким образом, ваш код будет выделен только в том случае, если он содержит одну из следующих строк:
