Rubycop emette messaggi del tipo:di alto livello documentazione relativa alla classe
app/controllers/welcome_controller.rb:1:1: C: Missing top-level class documentation comment.
class WelcomeController < ApplicationController
^^^^^
Mi chiedo cosa documentazione relativa alla classe di livello superiore assomiglia. Non è solo un commento, vero? Deve avere un formato speciale, ma quale?
E si sta dicendo che è necessario disporre di documentazione "commento" di una "classe di primo livello", che in questo caso è 'WelcomeController'. Aggiungi un commento sopra la definizione della classe per evitare questo messaggio. Potrebbero esserci anche altri modi per sbarazzarsi di questo messaggio. Vedere la documentazione per [rubocop] (https://github.com/bbatsov/rubocop/) per i dettagli. – vee
@vee Ho provato ad aggiungere un commento sotto la definizione della classe. Grazie. – DreamWalker
Per superare la necessità di aggiungere un commento reale è possibile aggiungere '#: nodoc:' nella parte superiore del file –