ruby - 使用 rakefile 从源代码生成文档

Question

我下载了 ruby​​ Twitter gem 源代码，并尝试使用 yard 生成文档，我通过gem install yard. 在 rakefile 中，我发现了以下内容，我假设它用于生成 Twitter gem 的文档：

require 'yard'
YARD::Rake::YardocTask.new

我试图require yard在 irb 中然后运行YARD::Rake::YardocTask.new，但什么也没发生。

你能帮我走上正轨吗？

Answer 1

来自YARD 文档：

第二个最明显的是通过 Rake 任务生成文档。您可以通过将以下内容添加到您的来做到这一点Rakefile：

YARD::Rake::YardocTask.new do |t|
  t.files   = ['lib/**/*.rb', OTHER_PATHS]   # optional
  t.options = ['--any', '--extra', '--opts'] # optional
end

和设置都是可选的files。将默认为并且将表示您可能要添加的任何选项。同样，通过键入shell可以获得完整的选项列表。您还可以使用 OPTS 环境变量覆盖 Rake 命令行中的选项：optionsfileslib/**/*.rboptionsyardoc --help

$ rake yard OPTS='--any --extra --opts'

总结一下：添加YARD::Rake::YardocTask.new到你的之后Rakefile，运行rake yard.