Sto facendo lo stesso. Quando c'è qualcosa di "da fare" nel mio codice, scrivo //TODO ... . Ma sono curioso di sapere quando è iniziato e se c'è un motivo per scrivere "cose da fare" in tutte le lettere maiuscole?
Inoltre, è bello avere un modo per cercare facilmente le sezioni di codice che hai sorvolato e che vuoi recuperare. Puoi eseguire una ricerca sensibile al maiuscolo / minuscolo per "TODO" per trovare immediatamente ciò che hai saltato prima.
"todo" (minuscolo) potrebbe potenzialmente far parte di una parola / funzione / variabile più grande, ma "TODO" (maiuscolo) probabilmente non lo sarà.
I'm curios to know when this started and if there is a reason for writing to-dos all capital?
L'idea con commenti come TODO e FIXME è di farli risaltare. In genere non si desidera spedire il codice che contiene tali marcatori nel codice: contrassegnano le cose da fare prima che il progetto possa essere considerato completo. L'utilizzo di ALL CAPS li rende un po 'più facili da individuare, a condizione che non usi ALL CAPS anche per molte altre cose del tuo codice.
Sia Eclipse che Visual Studio dispongono di funzionalità Elenco attività che forniscono automaticamente elenchi di righe di commento contenenti TODO.
Mi distingue solo ed è facile da cogliere ... niente di complicato!
Richiama l'attenzione sul fatto che esiste un todo.
È importante che sia sempre ovvio che qualcuno debba tornare al codice. I dettagli devono essere conosciuti solo dalla persona che torna per risolvere qualsiasi problema.
Se sei un utente vi usa:
/TODO
Ti farà arrivare molto velocemente.
Alcuni editor evidenziano solo le voci TODO maiuscole, quindi è più sicuro usare sempre le lettere maiuscole.
Visivamente TUTTO MAIUSC si distingue, ma non è molto leggibile. Durante la lettura del codice, scansionano come un blocco di una particolare dimensione. Non importa davvero quali siano le lettere. Si distinguono e possono essere visti molto rapidamente. Una volta che hai lavorato con i tag per un po ', il tuo cervello riconoscerà la parola per forma.
Dal punto di vista degli strumenti (IDE / Editor), la ricerca sensibile al maiuscolo / minuscolo avrà una percentuale di falsi positivi molto bassa su tutte le versioni di maiuscole. In alcuni stili di codifica c'è un piccolo rischio che una costante venga abbinata. La ricerca di tutto il testo sensibile al caso rende i falsi positivi ancora meno probabili.
Una volta che lo strumento viene visualizzato sullo schermo, il formato indica chiaramente QUI. Una volta focalizzata sulla posizione, la parte leggibile sarà il commento correlato.
Leggi altre domande sui tag comments