Я использую Ruby on Rails 3.0.7 и пишу документацию для своего приложения с помощью RDoc. Поскольку я не нашел в Сети хорошей документации с примерами, я хотел бы знать, как вообще использовать директиву :include:.
Можете ли вы привести пример использования этого в файлах приложений?
Вот документ: http://rdoc.rubyforge.org/RDoc/Markup.html
И вот очень простой пример:
Сначала рубиновый файл, скажем /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
AIUI, :include: позволяет вам (сюрприз) включать содержимое другого файла, сохраняя тот же уровень отступа блока, в котором появляется включение.
Он будет искать указанный файл в текущем каталоге, но это можно переопределить с помощью переключателя --include.
Если вам нужен пример, это может оказаться полезным.
