如何使用使用RDoc的`：include：`指令？

Question

我正在使用Ruby on Rails 3.0.7，並且正在爲我的應用程序使用RDoc來編寫一些文檔。由於我沒有在網上找到一些帶有例子的很好的文檔，我想知道的是如何使用:include:指令。

你可以讓我在應用程序文件中使用它的一個例子嗎？

Answer 1

這裏是DOC：http://rdoc.rubyforge.org/RDoc/Markup.html

這裏是一個非常簡單的例子：

首先紅寶石文件，說/tests/my_func.rb

#:include: doc.txt 

def my_function 
    puts "yo" 
end 

然後，DOC /tests/documentations/doc.txt

This describes the method very well 

在命令行中（從012開始執行）：

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

Answer 2

AIUI，:include:允許您（驚喜地）包含另一個文件的內容，並保持包含文件所在塊的縮進級別相同。

它將查找當前目錄中的指定文件，但可以使用--include開關替代該文件。

如果你想要一個例子，this可能會證明是有用的。