Domande con tag 'comments'

24
risposte

La scrittura di commenti all'interno di metodi non è una buona pratica? [duplicare]

Un amico mi ha detto che scrivere commenti nei metodi non è buono. Ha detto che dovremmo avere commenti solo per le definizioni del metodo (javadocs) ma non all'interno del corpo del metodo. Sembra che abbia letto in un libro che avere comment...
posta 28.02.2011 - 02:16
9
risposte

Che cosa significa XXX in un commento? [chiuso]

Che cosa significano le persone in genere ogni volta che vedi XXX in un commento. Occasionalmente, vedrò un commento come questo: # XXX - This widget really should frobulate the whatsit Naturalmente, posso dire cosa significa il commen...
posta 06.04.2011 - 01:51
7
risposte

TODO commenta con le scadenze?

Sfondo Sto lavorando in un team che sta cercando di implementare distribuzioni zero-downtime. Stiamo pianificando di utilizzare una strategia di distribuzione blu / verde per raggiungere questo obiettivo. Una delle cose che mi sto rendendo co...
posta 30.05.2017 - 02:12
19
risposte

Costringendo le persone a leggere e comprendere il codice anziché utilizzare commenti, riepiloghi delle funzioni e debugger? [duplicare]

Sono un giovane programmatore (finito all'università informatica ma ancora al di sotto di un anno di lavoro nel settore) e di recente ho ottenuto un lavoro lavorando su qualche codice C per un servizio web di dimensioni discrete. Guardando il...
posta 15.06.2013 - 23:33
11
risposte

Perché i blocchi di commenti /// sono importanti?

Qualcuno una volta ha detto che dovremmo prefissare tutti i nostri metodi con i blocchi di commento /// <summary> (C #) ma non ha spiegato il perché. Ho iniziato a usarli e ho scoperto che mi infastidivano un bel po ', quindi ho sm...
posta 21.09.2010 - 15:35
13
risposte

Il codice commentato è davvero sempre male? [duplicare]

Praticamente ogni testo sulla qualità del codice che ho letto concorda sul fatto che il codice commentato è una cosa negativa. Il solito esempio è che qualcuno ha cambiato una riga di codice e ha lasciato la vecchia linea come commento, appare...
posta 08.02.2011 - 10:37
9
risposte

Manutenzione del codice: aggiungere commenti nel codice o lasciarlo semplicemente al controllo della versione?

Ci è stato chiesto di aggiungere commenti con tag di inizio, tag di fine, descrizione, soluzione ecc. per ogni modifica che apportiamo al codice come parte della correzione di un bug / implementazione di un CR. La mia preoccupazione è che que...
posta 09.11.2012 - 19:32
16
risposte

I commenti in prima persona sono distratti e non professionali?

Mi sono appena trovato a scrivere il seguente commento in un codice (archaic Visual Basic 6.0) che stavo scrivendo: If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if Non sono sicuro del...
posta 18.07.2011 - 14:07
16
risposte

Buona idea di inserire i numeri dei bug in un commento all'inizio del file sorgente? [chiuso]

È una buona pratica inserire i numeri di bug nel file stesso all'interno di un commento di intestazione? I commenti sarebbero simili a questo: MODIFIED (MM/DD/YY) abc 01/21/14 - Bug 17452317 - npe in drill across in dashboard edit mode...
posta 12.03.2014 - 21:25
12
risposte

I commenti obsoleti sono un mito urbano?

Vedo costantemente persone che affermano che "i commenti tendono a diventare obsoleti". Il fatto è che penso di aver visto forse due o tre commenti obsoleti per tutta la mia carriera. Le informazioni obsolete in documenti separati sono sempre pr...
posta 19.04.2011 - 15:47