3

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 のタイプを判別できません。

では、ここで何をするのが正しいのでしょうか? ミックスインを正しく文書化することは可能ですか? そうでない場合、どうすれば警告を取り除くことができますか?

4

1 に答える 1

0

Yard UndocumentableErrordocs説明があなたの質問に答えるかもしれません。私の知る限り、警告を取り除くには、yardocクワイエットモードで実行するのがオプションです。

yardoc -q /path/to/source/file
于 2012-07-27T06:41:05.717 に答える