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 。