YARD를 사용하여 레일스의 url_helpers를 사용하는 방법을 문서화하는 방법은 무엇입니까?

Question

레일로 구현 된 서비스에 대한 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을 올바르게 문서화 할 수 있습니까? 그렇지 않다면 어떻게 경고를 없앨 수 있습니까?

Answer 1

Yard Undocumentable Error docs 설명이 귀하의 질문에 대한 답변 일 수 있습니다. 내 지식에 따라 경고를 없애기 위해 조용한 모드에서 yardoc을 실행하는 옵션이 있습니다 :

yardoc -q /path/to/source/file