Domande con tag 'comments'

domande con tag
6
risposte

Un'istruzione di Else dovrebbe essere utilizzata solo per un commento?

Ho trovato quanto segue in alcuni esempi di codice: if (urlStr) { NSImage *iconImage = [[NSWorkspace sharedWorkspace] iconForFile:urlStr]; node.nodeIcon = iconImage; } else { // it's a separator, don't bother with the icon } Que...
posta 28.04.2016 - 04:12
4
risposte

Quale è meglio, un commento dettagliato centrale o diversi più piccoli?

Per riformulare la domanda: quale è meglio, un commento centrale dettagliato o più piccoli "spruzzi"? Resta con me mentre preparo la scena: Ho questa funzione per prelevare un valore da un'implementazione di coda: int queue_pop(queue *li...
posta 14.12.2017 - 08:58
1
risposta

Stile: lunghezza della linea e avvolgimento di commenti in JavaScript [chiuso]

Sto bene con 80 caratteri per riga per riga (anche se alcuni considerano tale limite obsoleto ), ma io sono diviso (nessun gioco di parole) quando si tratta di dividere commenti su più righe , anziché scriverli su una riga (purché sia necessa...
posta 25.06.2017 - 08:44
1
risposta

Abuso di commenti XML per mantenere aggiornati i commenti (in C #)

Problema: I commenti si deteriorano quando si rinomina una variabile / classe / metodo / ecc in Visual Studio. Le occorrenze di detto simbolo nei commenti non vengono aggiornate dal refactoring (nessuna sorpresa, come potrebbe sapere VS)....
posta 12.03.2017 - 20:05
3
risposte

Il seguente commento è chiaro: "Fino a contestato" [chiuso]

Supponiamo di vedere il seguente modello nel codice: function foo() { ... var someFlag = false; // Until contested for/while/if () { ... // Possibly deeply nested in some non-trivial logic someFlag = true;...
posta 10.03.2017 - 20:13
3
risposte

Come si dovrebbe commentare e concedere in licenza un insieme di file di codice prima di caricarlo al pubblico? [duplicare]

Ho scritto un buon pezzo di codice negli ultimi giorni e sono pronto per git init e lo spingo su github. Ma prima di farlo, voglio farlo nel modo "corretto" nel caso in cui qualcun altro voglia usare il mio codice. Quindi suppongo di dove...
posta 19.06.2011 - 20:24
8
risposte

Devo duplicare i commenti in ogni file?

Ho un codice molto simile su più file nel mio progetto. Se un cliente desiderava un certo livello di codice commentato, dovrei investire il tempo necessario a duplicare il codice per ogni file. Penso che sarebbe semplicemente una perdita di temp...
posta 26.07.2011 - 09:19
4
risposte

Commenti privati in git

Ho bisogno di aggiungere una funzionalità ad un codice in un grande progetto e, a causa della complessità, trovo molto utile aggiungere commenti dettagliati a molte linee per tenere traccia di ciò che sta accadendo. Tuttavia, questo è solo per m...
posta 06.01.2014 - 07:13
4
risposte

Come discriminare commenti di codice e documentazione commentati

Dopo aver utilizzato gli strumenti di controllo della versione, non è più necessario commentare il vecchio codice. Tuttavia, alcuni membri del team continuano a commentare il vecchio codice. Pertanto, voglio pulirli. Voglio contrassegnare le...
posta 11.09.2012 - 13:19
9
risposte

Abbiamo bisogno di informazioni "evidenti" sulla documentazione?

So che abbiamo domande su commenti in generale ma io sono specificamente chiedendo la documentazione del metodo in stile Java Doc qui. Ho potato i commenti inutili come refactor e ho notato che il nostro codice ha descrizioni dolorosamente...
posta 29.02.2012 - 15:55