Top-level class documentation

ruby rubocop
DreamWalker picture DreamWalker · Apr 6, 2016 · Viewed 24.4k times · Source

Rubycop outputs messages like:

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

I wonder what does top-level class documentation look like. It's not just a comment, is it? It needs to have a special format, but which one?

Answer

lab419 picture lab419 · Jul 6, 2016

That said a simple comment like so will do nicely:

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

HTH

Related questions

Rubocop Linelength: How to ignore lines with comments?

Using a Rails 4 app I would like Rubocop to ignore lines with comments (just a comment or some code with an end of line comment) when checking if a line is to long. Is there a way to do this?

Read More
What is meant by 'Assignment Branch Condition Size too high' and how to fix it?

In my Rails app, I use Rubocop to check for problems. Today it gave me an error like this : Assignment Branch Condition size for show is too high. Here's my code : def show @category = Category.friendly.find(params[:id]) @categories = …

Read More
How to tell Rubocop to ignore a specific directory or file

My project is extending open-source classes from a third-party gem that we don't want to hold to the same coding standards as our own code. Refactoring the gem code isn't a viable option. We just want Rubocop to ignore the …

Read More