我下载了ruby Twitter gem源代码,我正在尝试使用yard来生成文档,我通过gem install yard
安装了该文件。在rakefile中,我发现了以下内容,我假设它用于生成Twitter gem的文档:
require 'yard'
YARD::Rake::YardocTask.new
我在irb中尝试require yard
,然后运行YARD::Rake::YardocTask.new
但没有任何事情发生。
你能帮助我走上正确的轨道吗?
答案 0 :(得分:15)
第二个最明显的是通过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
。