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?
RuboCop è un codice statico analizzatore di Ruby. Out of the box imporrà molte delle linee guida delineate nella comunità Ruby Style Guide.
La Guida di Ruby Style "commento" sezione non usa la frase "mancante di alto livello di classe documentazione commento", ma dalla lettura della sezione di guida su commenti, si può dedurre rapidamente dagli esempi che commentano classi e moduli è raccomandato.
Il motivo è, quando si utilizza rdoc, i commenti per le classi/moduli verranno utilizzati per generare il riferimento al codice, qualcosa che è importante se si scrive codice per se stessi, per una squadra o per una versione generale dagli altri.
Detto questo un semplice commento in questo modo farà bene:
# This shiny device polishes bared foos
class FooBarPolisher
...
HTH
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 –