Domande con tag 'comments'

domande con tag
12
risposte

Corretto il commento per mettere gli argomenti della funzione booleana che sono "falsi"?

Da alcuni progetti open source, ho raccolto il seguente stile di codifica void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } Ho sempre dei dubbi su ciò che false significa qui. Significa "di...
posta 20.09.2013 - 17:23
11
risposte

"// ..." commenti alla fine del blocco di codice dopo} - buono o cattivo? [chiuso]

Ho visto spesso questi commenti essere usati: function foo() { ... } // foo while (...) { ... } // while if (...) { ... } // if e talvolta anche fino a if (condition) { ... } // if (condition) Non ho mai capito questa pra...
posta 01.03.2011 - 12:35
11
risposte

Perché dovremmo usare brevi funzioni per segmentare il nostro codice? [duplicare]

Ho notato una tendenza crescente nel mondo della programmazione che afferma che è buona norma separare i blocchi di codice nelle proprie funzioni. Ovviamente, se quel blocco di codice è riutilizzabile, dovresti farlo. Quello che non capisco è...
posta 04.09.2013 - 03:01
9
risposte

Perché la maggior parte dei linguaggi di programmazione non annidano i commenti dei blocchi?

Alcuni lo fanno, ma nessuno di quelli popolari per quanto ne so. C'è qualcosa di negativo nei commenti di annidamento? Ho intenzione di inserire i commenti dei blocchi nella (piccola) lingua su cui sto lavorando, ma mi piacerebbe sapere se qu...
posta 02.06.2011 - 11:21
4
risposte

È necessario "Ottiene o imposta .." nella documentazione XML delle proprietà?

Sto cercando una raccomandazione di best practice per i commenti XML in C #. Quando si crea una proprietà, sembra che la documentazione XML prevista abbia il seguente formato: /// <summary> /// Gets or sets the ID the uniquely identifies...
posta 28.03.2013 - 13:31
6
risposte

Perché è sbagliato commentare il codice e poi rimuoverlo gradualmente per tenere traccia di ciò che ho già fatto e di ciò che resta da fare?

Ogni volta che scopro che una grande parte del mio codice deve essere cambiata, o perché non è corretta o perché deve essere adattata alle principali modifiche architettoniche necessarie per altri motivi, questo è ciò che faccio tipicamente:...
posta 20.08.2018 - 22:24
6
risposte

È buona norma commentare con il numero di rilascio?

Ho visto molti numeri di rilascio dai commenti di codice jQuery . (In realtà, c'erano 69 numeri di rilascio nel codice jQuery.) Penso che sarebbe una buona pratica, ma non ho mai visto alcuna linea guida. Se è una buona pratica, quali sono l...
posta 02.05.2012 - 03:53
6
risposte

Scrivi commenti per un piccolo codice con uno sfondo piuttosto grande [duplicato]

Quindi ho dovuto scrivere del codice relativo alla suddivisione di curve di Bezier in parti. Ho letto diversi riferimenti e ho riferito in particolare questo dettagliato . Il risultato finale del codice è tuttavia intorno a 20-30 LOC. Ma s...
posta 10.09.2015 - 09:23
8
risposte

I commenti in linea sono 'modificati da' inline nei negozi che usano il controllo di revisione?

Lo sviluppatore senior del nostro negozio insiste sul fatto che ogni volta che il codice viene modificato, il programmatore responsabile dovrebbe aggiungere un commento in linea che indichi cosa ha fatto. Questi commenti di solito assomigliano a...
posta 16.02.2011 - 17:25
9
risposte

Quali sono i tuoi pensieri su Periodi / Punti completi nei commenti al codice? [chiuso]

Ho visto questo chiesto nella SO Tavern , quindi sto postando la domanda qui. Ho pensato che fosse una domanda interessante. (Naturalmente non appartiene a SO, ma penso che sia OK qui.) Aggiungete punti (o, come scritto dall'OP, "punti fermi...
posta 09.11.2010 - 02:56