Le migliori pratiche per i commenti sopra i metodi in un'applicazione Grails?

1

Sto scrivendo un'applicazione Grails e non sono sicuro di quale sia la migliore pratica per quanto riguarda i commenti al di fuori dei blocchi di metodo. Ho fatto un po 'di ricerche e sembra che ci siano opinioni contrastanti su come e quando utilizzare questi tipi di commenti.

In un sacco di codice sorgente ho visto sembra che ci siano commenti sopra ogni metodo che dettagliano ciò che fa quel metodo. Non sono sicuro che i graal dovrebbero essere differnet?

La mia domanda è: dovrei avere un commento sopra ogni metodo nei miei controller, servizi e oggetti di dominio?

cioè

/*
* This method displays the index page
*/
def index(){
render view : "index"
}
    
posta Travis 05.11.2013 - 11:14
fonte

1 risposta

1

Non penso che i graal abbiano implementato una vista diversa per i commenti.

Poiché i commenti sono vantaggiosi per i codici come commenti facilitano la comprensione raccogliendo informazioni in un unico posto.

Rende il codice comprensibile per gli sviluppatori che dovranno lavorare sullo stesso codice. Poiché i commenti in eccesso possono essere caricati, usa meno e commenti precisi.

Utilizza i commenti per

  • Quando non è possibile utilizzare un nome di funzione per spiegare qualcosa
  • Il tuo intento dietro una decisione
  • Chiarimento del codice che non puoi modificare, come i risultati di una chiamata alla libreria
  • Avviso di conseguenze
  • TODO (in misura ragionevole)
  • Amplifica l'importanza di qualcosa apparentemente insignificante
  • Javadoc in API pubbliche
risposta data 19.11.2013 - 10:22
fonte

Leggi altre domande sui tag