ruby - 最上位クラスのドキュメント

Question

Rubycop は次のようなメッセージを出力します。

app/controllers/welcome_controller.rb:1:1: C: Missing top-level class documentation comment.
class WelcomeController < ApplicationController
^^^^^

トップレベルのクラスのドキュメントはどのように見えるのだろうか。コメントだけじゃないですよね？特別な形式が必要ですが、どの形式ですか?

Answer 1

つまり、次のような簡単なコメントでうまくいくでしょう。

# This shiny device polishes bared foos
class FooBarPolisher
       ...

Answer 2

私はこのチェックを無効にする方法を探してここに行き着きました。

Documentation:
  Enabled: false

あなたの.rubocop.ymlファイルに。