🔖

Rubocopのエラー「Missing top-level class documentation comment.」の対処法

2021/01/02に公開1

事象

rubocopで「Missing top-level class documentation comment.」エラーが発生する。

app/controllers/application_controller.rb:1:1: C: Style/Documentation: Missing top-level class documentation comment.
class ApplicationController < ActionController::Base
^^^^^

解決策

rubocop.ymlに下記コードを記述する。

Style/Documentation:
  Enabled: false

参考

Discussion

kaibakaiba
# コメントを書く
class ApplicationController < ActionController::Base

こちらが正攻法ですのでこちらも紹介いただいたほうが良いかなと思いました。