ruby-on-rails - 为 Rails 应用程序创建 Rdoc

Question

我想为我的 rails (2.3.8) 项目生成一个文档。当我尝试

rake doc:rails
rake doc:rerails

它为所有类创建文档，包括标准 ruby​​ 类和供应商目录中的所有 ruby​​ 文件（插件等）

如何仅为 ruby​​ 类、以下目录中的文件创建 rdoc 文档

1. app 文件夹（所有模型、控制器和视图）
2. 配置文件夹
3. 库文件夹

Answer 1

我将此添加到我的 Rakefile 中；

RDoc::Task.new :rdoc do |rdoc|
  rdoc.main = "README.rdoc"

  rdoc.rdoc_files.include("README.rdoc", "doc/*.rdoc", "app/**/*.rb", "lib/*.rb", "config/**/*.rb")
  #change above to fit needs

  rdoc.title = "App Documentation"
  rdoc.options << "--all" 
end

然后运行；

rake rdoc

查看 RDoc::Task 文档了解更多http://rdoc.rubyforge.org/RDoc/Task.html

诚然，我使用的是 rails 3 应用程序，但我认为这同样适用。

Answer 2

您可以使用rake doc:app为应用程序生成文档。

引用Rails 指南第 2.4 节：

doc: 命名空间具有为您的应用程序、API 文档、指南生成文档的工具。文档也可以被剥离，这主要用于精简你的代码库，就像你正在为嵌入式平台编写 Rails 应用程序一样。

rake doc:app 在 doc/app 中为您的应用程序生成文档。rake doc:guides 在 doc/guides 中生成 Rails 指南。rake doc:rails 在 doc/api 中为 Rails 生成 API 文档。