最上位クラスのドキュメント
Rubycopは次のようなメッセージを出力します。
app/controllers/welcome_controller.rb:1:1: C: Missing top-level class documentation comment.
class WelcomeController < ApplicationController
^^^^^
トップレベルのクラスのドキュメントはどのように見えるのでしょうか。それは単なるコメントではありませんか？特別なフォーマットが必要ですが、どれですか？
それはそのような簡単なコメントがうまくいくと言った：
# This shiny device polishes bared foos
class FooBarPolisher
...
HTH
Rubocopドキュメント から：
RuboCopはRuby静的コードアナライザーです。すぐに使用できます。コミュニティで概説されているガイドラインの多くを強制します Ruby Style Guide 。
Ruby Style Guide "comment"セクションは "Missing top-level class documentation comment"というフレーズを使用していませんが、コメントに関するガイドセクションを読むことで、コメントする例からすぐに推測できますクラスとモジュールを推奨します。
理由は、rdocを使用すると、クラス/モジュールのコメントがコードへの参照を生成するために使用されるためです。他人によるリリース。
私はここでこのチェックを無効にする方法を探しましたが、それがあなたの場合であれば、
Documentation:
Enabled: false
.rubocop.ymlファイルで。