使用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和options设置都是可选的.files将默认lib/**/*.rb和options意志表示你可能要添加任何选项.同样,通过键入yardoc --helpshell 可以获得完整的选项列表.您还可以使用OPTS环境变量覆盖Rake命令行中的选项:

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

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