Документация по Ruby Yard: как добавить "дословно" (чтобы сгенерировать что-то вроде тега <pre>)

Question

Я хочу, чтобы кусок кода, например хэш, отображался с фиксированной гарнитурой в полученном html. Предположим, это содержимое моего файла:

=begin

One example of valid hash to this function is:
{
    :name => "Engelbert",
    :id  => 1345
}
=end
def f hash_param
  # ...
end

Как проинструктировать двор (используя версию по умолчанию 0.9.15) так yard doc file.rb сгенерирует, для примера хеша, эквивалент добавления 4 обратных слешей к формату уценки или 4 начальных пустых мест в stackru или <pre> тег в HTML, что приводит к дословному / фиксированному формату шрифта в результирующем HTML?

Ожидаемый результат:

One example of valid hash to this function is:
{
    :name => "Engelbert",
    :id  => 1345
}

Answer 1

РЕДАКТИРОВАТЬ

> gem install redcarpet
> yard doc --markup-provider redcarpet --markup markdown - file.rb

Следует обернуть содержимое file.rb в пределах <pre> тег, производящий эту страницу.

---

Используйте @example

Показать пример фрагмента кода для объекта. Первая строка - необязательный заголовок.

# @example One example of valid hash to this function is:
#   {
#       :name => "Engelbert",
#       :id  => 1345
#   }
def f hash_param
  # ...
end

Answer 2

Может быть, я не понимаю вашего вопроса:

эквивалент добавления 4 обратных косых черт в формат уценки или 4 начальных пустых пробелов в stackoverflow

Если я использую 4 начальных пустых места в своем коде следующим образом:

      =begin

One example of valid hash to this function is:
    {
        :name => "Engelbert",
        :id  => 1345
    }
=end
def f hash_param
  # ...
end

тогда я получаю

Но, возможно, вы также можете использовать :

      @param hash_param
@option hash_param [String] :name The name of...
@option hash_param [Integer] :id The id of...

и вы получите:

Отказ от ответственности: я использовал для своих примеров ярд 0.9.26.