Нормально ли, что YARD не заменяет "code" на <code>code</code>?

Я только начинаю использовать YARD для документирования моего приложения Rails. Я не указал какого-либо конкретного обработчика Markup, но я бы ожидал, что "code" будет преобразован в code, что, похоже, не происходит. Это нормальное поведение? Должен ли я добавить дополнительный параметр, чтобы сделать эту работу? Спасибо.

Ответ 1

Синтаксис немного отличается от уценки (markdown vs rdoc), я полагаю. Использование '+' работает. + code + получает рендеринг в блоке <code>.

Ответ 2

Из GitHub я использовал для использования обратных ссылок для встроенных комментариев кода. Поэтому после некоторых исследований я нашел следующее, очень приятное решение.

Добавьте драгоценный камень redcarpet в свой Gemfile
Запустить команду bundle
Добавить --markup=markdown в ваш .yardopts файл
Запустите сервер YARD с помощью yard server --reload
Открыть локальный хост: 8808 в вашем браузере

Теперь вы можете использовать синтаксис, например, на GitHub, например.

```ruby
def bla; puts 'bla'; end
```

или

`this is inline code`

Ницца!:)

Ответ 3

Без уценки YARD отобразит блок кода для отступаемой строки, например.

  # This is a useful POSIX regex:
  #   [[:lower:]]{2}[[:digit:]]{3}[[:lower:]]{2}[[:digit:]]{4}

Два пространства отступа кажутся достаточными.