Есть ли у Ruby Yard функция, сравнимая с RDOC: включите: TAG?

Question

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

Делает Площадка есть похожий тег или функция?

Answer 1

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

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.