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

Question

我正在使用Ruby on Rails 3.0.7，我正在使用 RDoc 为我的应用程序编写一些文档。由于我没有在Web上找到一些带有示例的好文档，我想知道的是如何使用:include:指令。

您能举例说明在应用程序文件中使用它吗？

Answer 1

AIUI，:include:允许你（惊讶地）包含另一个文件的内容，保持包含出现的块的缩进级别。

它将在当前目录中查找命名文件，但您可以通过--include开关覆盖它。

如果你想要一个例子，this可能会有用。

Answer 2

以下是文档：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