Question

我下载了ruby Twitter gem源代码，我正在尝试使用yard来生成文档，我通过gem install yard安装了该文件。在rakefile中，我发现了以下内容，我假设它用于生成Twitter gem的文档：

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

我在irb中尝试require yard，然后运行YARD::Rake::YardocTask.new但没有任何事情发生。

你能帮助我走上正确的轨道吗？

Answer 1

来自the YARD docs：

第二个最明显的是通过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代表您的所有选项可能想要添加。同样，可以使用完整的选项列表在shell中键入yardoc --help。您也可以覆盖选项在带有OPTS环境变量的Rake命令行中：
$ rake yard OPTS='--any --extra --opts'

总结：将YARD::Rake::YardocTask.new添加到Rakefile后，运行rake yard。

使用rakefile从源生成文档

1 个答案: