Documentation de classe de niveau supérieur
Rubocop affiche des messages comme:
app/controllers/welcome_controller.rb:1:1: C: Missing top-level class documentation comment.
class WelcomeController < ApplicationController
^^^^^
Je me demande à quoi ressemble la documentation de classe de niveau supérieur. Ce n'est pas seulement un commentaire, n'est-ce pas? Il doit avoir un format spécial, mais lequel?
Cela dit, un simple commentaire comme celui-ci fera l'affaire:
# This shiny device polishes bared foos
class FooBarPolisher
...
HTH
RuboCop est un Ruby analyseur de code statique. Hors de la boîte, il appliquera de nombreuses directives décrites dans la communauté Ruby Style Guide .
La section Ruby Guide de style "commentaire" n'utilise pas l'expression "Commentaire de documentation de classe de niveau supérieur manquant" mais en lisant la section de guide sur les commentaires, vous pouvez rapidement déduire des exemples que commentant classes et modules est recommandé.
La raison en est que lorsque vous utilisez rdoc, les commentaires pour les classes/modules seront utilisés pour générer la référence au code, ce qui est important que vous écriviez du code pour vous-même, pour une équipe ou pour le général communiqué par d'autres.
Je me suis retrouvé ici à chercher un moyen de désactiver cette vérification, si c'est votre cas, mettez
Documentation:
Enabled: false
dans votre fichier .rubocop.yml.