Question

我在生成项目文档时遇到了几个警告，因为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 来抑制所有警告，但我宁愿压制单个扩展而不是一切。

据我所知，在帮助中，我可以 - 排除但是现在，违规类是外部宝石的一部分。我也试过 @！parse 但没有成功

class MyClass

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

Answer 1

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

class MyClass
  send :include, Virtus.model
end

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

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

让YARD忽略某些类扩展

1 个答案: