ruby-on-rails - 如何使用 RDoc 使用 `:include:` 指令？

Question

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

你能给我一个在应用程序文件中使用它的例子吗？

Answer 1

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

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

如果你想要一个例子，这可能很有用。

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