Имеет ли Ruby Yard функцию, сравнимую с тегом RDoc: include:?

Question

RDoc имеет тег: include: (см. Внизу эту страницу ), который будет принимать произвольный текстовый файл и форматировать его так, как если бы он был с отступом, где бы ни начиналось включение.Это отличный способ получить исходный код для примеров документации.

Имеет ли Двор похожий тег или функцию?

Answer 1

В настоящее время YARD поддерживает только встраивание документации из других строк документов объекта в виде:

class Foo
  # Docstring here
  def method; end

  # Here is some more docs and {include:Foo#method}
  def bar; end
end

Включение файла было расплывчато, но раньше оно никогда не запрашивалось, поэтому оно не было приоритетным.Если вы хотите открыть проблему на http://github.com/lsegal/yard/issues - мы можем убедиться, что она будет отслежена и добавлена ​​для предстоящего выпуска 0.7.0.