如何使用Yard for Rails视图生成文档?

Add*_*dsy 5 ruby ruby-on-rails yard ruby-on-rails-3

我刚刚开始使用Yard来生成我的文档,虽然它对我的模型和控制器非常有用,但似乎无法让它为视图生成任何内容

我尝试了各种不同的方法使其正常工作。目前,我已经设置了一个rake任务来生成看起来像这样的文档

YARD::Rake::YardocTask.new do |t|
    t.files   = ['lib/**/*.rb', 'app/**/*.rb', 'app/views/**/*.erb']
    t.options = []
end
Run Code Online (Sandbox Code Playgroud)

我认为,最后一条路径应该包含我的观点,但是当我查看文档时,根本没有提到任何这些文件。有什么想法吗?

干杯

Sim*_*tti 0

模板文件不应包含 Ruby 方法或业务逻辑。您想生成什么类型​​的文档?

  • 您好,我想添加模板的描述,说明模板的用途(例如“用于显示用户个人资料的模板”)。有时,当我需要大部分相同的东西但有一些细微的差异时,我可以将变量传递给模板。因此,在渲染部分时,我可能会使用类似 'render :partial => "user_summary", :locals => {:displayAvatar => true}' 的内容。通过测试模板中的此变量,我可以使用带有或不带有头像的相同模板,而不是使用 2 个模板。我想在文档中包含这些变量的列表 (2认同)