Ruby RDocTask类用法及代码示例

RDoc::Task 创建以下 rake 任务以生成和清理 RDoc 输出：

rdoc

此 RDoc 任务的主要任务。

clobber_rdoc

删除所有 rdoc 文件。此目标会自动添加到主 clobber 目标。

重新文档

从头开始重建 rdoc 文件，即使它们没有过期。

简单示例：

require 'rdoc/task'

RDoc::Task.new do |rdoc|
  rdoc.main = "README.rdoc"
  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
end

传递给块的rdoc 对象是 RDoc::Task 对象。有关可用的自定义选项，请参阅 RDoc::Task 类的属性列表。

指定不同的任务名称

您可能希望给任务一个不同的名称，例如，如果您正在生成两组文档。例如，如果您想拥有一组包含私有方法的开发文档：

require 'rdoc/task'

RDoc::Task.new :rdoc_dev do |rdoc|
  rdoc.main = "README.doc"
  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
  rdoc.options << "--all"
end

然后将任务命名为：rdoc_dev、:clobber_ rdoc_dev 和 :re rdoc_dev。

如果您希望拥有完全不同的任务名称，则将 Hash 作为第一个参数传递。使用 :rdoc 、 :clobber_rdoc 和 :rerdoc 选项，您可以根据自己的喜好自定义任务名称。

例如：

require 'rdoc/task'

RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean",
               :rerdoc => "rdoc:force")

这将创建任务 :rdoc 、 :rdoc:clean 和 :rdoc:force 。