如何使用 YARD 记录 Rails 的 url_helpers 的使用情况?

ott*_*ath 5 ruby documentation ruby-on-rails yard

当尝试为使用 Rails 实现的服务生成 YARD 文档时,我收到以下警告:

$ yardoc
[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: 
          YARD::Parser::UndocumentableError for class MyClass
[warn]:     in file 'app/models/my_class.rb':7:
  7: include Rails.application.routes.url_helpers
Run Code Online (Sandbox Code Playgroud)

我的理解是 YARD 无法确定 mixin 的类型,因为它仅在运行时可用。

那么在这里该怎么做才是正确的呢?是否可以正确记录 mixin?如果没有,我该如何摆脱警告?

Kas*_*yap 0

Yard Undocumentable Error 文档描述可能会回答您的问题。要摆脱警告,据我所知,yardoc可以选择以安静模式运行:

yardoc -q /path/to/source/file 
Run Code Online (Sandbox Code Playgroud)