Domande con tag 'comments'

domande con tag
6
risposte

E 'necessario scrivere un commento javadoc per OGNI parametro nella firma di un metodo?

Uno degli sviluppatori del mio team crede che sia necessario scrivere un commento javadoc per OGNI parametro nella firma di un metodo. Non penso che sia necessario, e in effetti penso che possa persino essere dannoso. Prima di tutto, penso ch...
posta 11.05.2011 - 20:47
5
risposte

Va bene inserire un collegamento a siti di domande e risposte nei commenti di un programma?

In un bel po 'di codebase puoi vedere commenti come: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) Quindi ho alcune domande, ma sono tutte correlate. Va bene inserire il link alle domande SO nei commenti di un pro...
posta 17.05.2010 - 18:42
9
risposte

Qual è un buon modo per commentare le clausole if-else? [chiuso]

Ogni volta che sto scrivendo un tipico if-else-construct in qualsiasi lingua mi chiedo quale sarebbe il modo migliore (in termini di leggibilità e panoramica) di aggiungere commenti ad esso. Soprattutto quando si commenta la clausola else, i com...
posta 04.04.2012 - 12:25
7
risposte

Perché non più lingue supportano i commenti ricorsivi / nidificati? [duplicare]

La maggior parte delle lingue con cui ho lavorato non supportano i commenti ricorsivi / nidificati. C'è qualche motivo per cui i progettisti di linguaggio dovrebbero scegliere di non implementare questo? È ingannevolmente complesso?...
posta 26.10.2011 - 10:27
16
risposte

Una lingua che non consente commenti produce un codice più leggibile? [chiuso]

Per pura curiosità, ho iniziato a chiedermi se un linguaggio che non consente commenti possa produrre codice più leggibile, in quanto si sarebbe costretti a scrivere un codice di commento automatico. Poi di nuovo, potresti scrivere codice alt...
posta 11.01.2011 - 16:46
4
risposte

Esiste una giustificazione per lasciare indicatori di conflitto nel codice di accesso?

Considera i marcatori di conflitto. cioè:. <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD Nel caso particolare che mi ha motivato a postare questa domanda, il membro del team resp...
posta 25.10.2011 - 19:38
7
risposte

Uso di NotImplementedException

È considerata una cattiva pratica lanciare NotImplementedException per il codice che non hai ancora scritto? Forse i commenti di TODO sarebbero considerati più sicuri?     
posta 04.01.2012 - 21:50
2
risposte

Qual è l'approccio migliore per i commenti di codice in linea?

Stiamo eseguendo alcuni refactoring su una base di codice legacy di 20 anni e sto discutendo con il mio collega riguardo al formato dei commenti nel codice (plsql, java). Non esiste un formato predefinito per i commenti, ma nella maggior part...
posta 07.11.2012 - 21:53
6
risposte

Cosa dovrei includere nell'intestazione della documentazione della mia classe

Sto cercando il formato informativo della documentazione di classe per le mie classi Entity, Business Logic e Data Access. Ho trovato seguenti due formati da qui Formato 1 ///----------------------------------------------------------...
posta 06.10.2010 - 14:50
1
risposta

Introduzione di variabili locali aggiuntive come sostituzione di commenti

È bello usare variabili locali aggiuntive, tecnicamente superflue, per descrivere cosa sta succedendo? Ad esempio: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Qu...
posta 14.11.2016 - 12:18