Domande con tag 'comments'

domande con tag
1
risposta

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

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 ut...
posta 05.11.2013 - 11:14
2
risposte

Come scrivere commenti per spiegare il "perché" dietro la funzione di callback quando i nomi di funzione e parametro sono insufficienti?

Come dovrei avvicinarmi ai commenti di scrittura per le funzioni di callback? Voglio spiegare il "perché" dietro la funzione quando i nomi di funzione e parametro sono insufficienti per spiegare cosa sta succedendo. Mi sono sempre chiesto per...
posta 17.09.2013 - 04:26
0
risposte

/// commenti di riepilogo senza il rigonfiamento [chiuso]

Mi piace la funzione di documentazione che ottieni con /// commenti, ma odio il boilerplate. C'è un modo per fare in modo che lo studio visivo usi solo i commenti sopra una classe come la documentazione, senza aggiungere due righe di testo al...
posta 16.10.2018 - 02:31
6
risposte

Quali informazioni deve contenere un buon commento (metodo / classe)? [chiuso]

Questo è qualcosa che mi ha infastidito per un po 'di tempo. Immagino che ci siano un paio di ovvi aspetti importanti che dovrebbero entrare in un commento, come ad esempio: L'autore (i) Una descrizione dei parametri (e dei loro tipi, se...
posta 29.07.2011 - 01:08
2
risposte

Collegamenti alla documentazione nei commenti? [duplicare]

A volte metto un link al sito dove ho copiato un pezzo di codice nel caso in cui dimentichi cosa fa. È una cattiva pratica? Dovrei copiare la spiegazione dal sito invece di collegarla ad essa?     
posta 15.05.2018 - 20:25
3
risposte

I commenti del metodo dovrebbero essere scritti come se tutto funzionasse?

Se ho un metodo per cercare un indirizzo email valido in un array, è possibile: Restituisce l'indirizzo email Restituisce false se non è stata trovata un'email. Genera un'eccezione se è stata trovata un'email, ma non era valida. Il co...
posta 26.01.2016 - 12:06
2
risposte

Riferimento alle domande StackOverflow nei commenti [duplicato]

Spesso durante la codifica mi trovo bloccato su un problema particolarmente difficile e cercherò una soluzione. Il più delle volte questo mi porta a una domanda StackOverflow che fornisce una soluzione completa o parziale, spesso con codice ch...
posta 24.07.2014 - 07:04
5
risposte

Utilizzo di ID HTML o classe anziché commenti

Ho due elementi in un contenitore. Non ho bisogno di dare i due elementi interni a nessuno id o class poiché non richiedono riferimenti CSS o JS. Gli sta dando un id solo allo scopo di comunicare la loro buona pratica? Oppure d...
posta 27.12.2016 - 22:15
1
risposta

Commenti per una classe che non è un'entità

Secondo le convenzioni di commento di Java, i commenti delle classi dovrebbero descrivere una "cosa", piuttosto che "azioni". È facile quando la classe È una cosa (ad esempio un Clown), ma cosa succede se non lo è? In questo caso, ShapeProv...
posta 23.01.2015 - 16:22
1
risposta

Il numero del requisito / numero / codice dovrebbe essere incluso nei commenti del codice sorgente? [duplicare]

Sto lavorando su una serie di progetti di manutenzione e includo sempre il numero / numero di requisito / codice nei commenti ogni volta che aggiungo o modifichi il codice. In tal modo fornisco la tracciabilità dai requisiti al codice e ritorn...
posta 10.07.2017 - 11:46