当尝试为用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的类型,因为它只在运行时可用。
那么在这里应该做什么呢?是否可以正确记录混音?如果没有,我该如何消除警告?
最佳答案
Yard Undocumentable Error docs描述可能会回答您的问题。为了消除警告,据我所知,可以选择在安静模式下运行yardoc
:
yardoc -q /path/to/source/file