1

在生成我的项目文档时，我收到了几个警告，因为 YARD 无法解析一些外部类扩展

[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class MyClass
[warn]:     in file 'lib/Project/myclass.rb':7:

    7: include Virtus.model

问题的根源是一个无法解析的类扩展。我知道我可以运行yard -q来禁止所有警告，但我宁愿禁止单个扩展而不是所有内容。

据我在帮助中看到的，我可以--exclude但现在，有问题的类是外部宝石的一部分。我也试过@!parse没有成功

class MyClass

  # @!parse Virtus.model
  include Virtus.model
end
4

1 回答 1

0

我遇到了同样的问题，我可以通过混淆包含来隐藏警告，因此 YARD 无法检测到它：

class MyClass
  send :include, Virtus.model
end

github上有更多关于这个问题的讨论：

https://github.com/lsegal/yard/issues/546

于 2014-01-04T22:53:48.527 回答