Как использовать директиву `: include:`, используя RDoc?

Question

Я использую Ruby on Rails 3.0.7 и пишу документацию для моего приложения, используя RDoc .Поскольку я не нашел в Интернете хорошей документации с примерами, я хотел бы знать, как вообще использовать директиву :include:.

Можете ли вы привести пример использования этогов файлах приложений?

Answer 1

Вот документ: http://rdoc.rubyforge.org/RDoc/Markup.html

А вот очень простой пример:

Сначала файл ruby, скажем /tests/my_func.rb

#:include: doc.txt 

def my_function
  puts "yo"
end 

ЗатемДокумент /tests/documentations/doc.txt

This describes the method very well

В командной строке (выполняется из /tests):

rdoc -i /Users/benjaminroth/Sites/Tests/rdoc/descriptions

Answer 2

AIUI, :include: позволяет (неожиданно) включать содержимое другого файла, сохраняя тот же уровень отступа для блока, в котором появляется включение.

Он будет искать названный файл втекущий каталог, но его можно переопределить с помощью переключателя --include.

Если вам нужен пример, этот может оказаться полезным.