如何使用YARD记录Rails'url_helpers的使用？

Question

当尝试为使用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

我的理解是，YARD无法确定mixin的类型，因为它只能在运行时使用。

那么在这里做什么是正确的？是否可以正确记录mixin？如果没有，我该如何摆脱警告？

Answer 1

Yard Undocumentable Error docs说明可能会回答您的问题。为了摆脱警告，据我所知，在安静模式下运行yardoc是选项：

yardoc -q /path/to/source/file