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

发布于 2024-09-27 01:28:13 字数 341 浏览 6 评论 0原文

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

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

YARD::Rake::YardocTask.new do |t|
    t.files   = ['lib/**/*.rb', 'app/**/*.rb', 'app/views/**/*.erb']
    t.options = []
end

我相信,最后一条路径应该让它包含我的视图,但是当我查看文档时,没有提到任何这些文件全部。有什么想法吗?

干杯

I have just started using Yard to generate my docs and whilst it works great for my models and controllers, I can't seem to get it to generate anything for the views

I've tried a variety of different ways to get it to work. Currently I've set up a rake task to generate the docs that looks something like this

YARD::Rake::YardocTask.new do |t|
    t.files   = ['lib/**/*.rb', 'app/**/*.rb', 'app/views/**/*.erb']
    t.options = []
end

The last path there, I believe, should get it to include my views but when I look at the docs, there's no mention of any of these files at all. Any ideas why?

Cheers

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

远山浅 2024-10-04 01:28:13

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

Template files are not expected to contain Ruby methods or business logic. What kind of documentation would you like to generate?

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文