Perché tutti scrivono commenti da fare in maiuscolo? [chiuso]

9

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'è una ragione per scrivere "cose da fare" in tutte le lettere maiuscole?

comments

— Mohsen
fonte

20

Perché lo ABBIAMO davvero SIGNIFICATO (non ci siamo mai veramente fatti avanti)

— Anthony Pegram,

3

in modo da editori li possono contrassegnare e consente di cercare attraverso di loro (elenco delle attività di Eclipse per esempio)

— cricchetto maniaco del

6

Dal momento che non si poteva effettivamente mettere in grassetto il testo all'interno del codice, era necessario un modo per far risaltare le cose importanti. Quindi ...

— Karlson,

4

Perchè importa?

— Rook,

3

Scrivo//todo:...

— BЈовић

23

Inoltre, è fantastico avere un modo per cercare facilmente sezioni di codice su cui hai passato il gloss e su cui vuoi tornare. Puoi fare 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à.

— Buttle Butkus
fonte

4

Inoltre, consente agli editor di evidenziarlo. gedit lo fa, per esempio, e lo fa solo per tutte le maiuscole TODO. Qualunque sia la ragione, è abbastanza incentivo per me scrivere in maiuscolo.

4

@delnan: questa è una tautologia. È stato fatto per sporgere, quindi le persone lo hanno usato, quindi qualcuno ha aggiunto l'evidenziazione della sintassi in VIM per distinguersi di più, quindi le persone lo usano per distinguersi. Le persone non lo usano perché l'editor lo fa risaltare lo usano perché è comune farlo e quindi l'editor lo fa risaltare. Puoi fare in modo che qualsiasi cosa si distingua in vim semplicemente cambiare l'evidenziazione della sintassi in modo appropriato, è altrettanto facile tododistinguersi, ma non ha senso in quanto la convenzione è usare TODO.

— Martin York,

1

@LokiAstari: Come ho detto, io per un incantesimo in capitali perché più editori evidenziano che per impostazione predefinita. Ma forse sono un'eccezione: abbastanza giovane (quindi non avrei potuto farlo prima che gli editori lo supportassero) e (purtroppo) troppo di un capriccio e di un pigro culo per regolare manualmente l'evidenziazione della sintassi.

Bello anche per il povero che ha bisogno di ripulire dopo di te e per chiunque abbia bisogno di controllare il tuo codice prima che sia completo. Possono vedere a colpo d'occhio ciò che non è stato ancora fatto a causa di questa convenzione.

— sq33G

2

Ho incontrato TODO a caso misto all'interno di un nome variabile come filesToDownload. Naturalmente, la ricerca "solo parole intere" risolve questo problema.

— dan04,

8

Sono curioso di sapere quando è iniziato e se c'è un motivo per scrivere cose da fare tutto il capitale?

L'idea con commenti come TODO e FIXME è di farli risaltare. Generalmente non si desidera spedire il codice che ha tali marcatori nel codice: segnano le cose da fare prima che il progetto possa essere considerato completo. L'uso di TUTTI MAIUSC li rende un po 'più facili da individuare, a condizione che non si utilizzino TUTTI MAIUSCOLI per molte altre cose nel codice.

— Caleb
fonte

5

Sia Eclipse che Visual Studio hanno funzionalità Elenco attività che forniscono automaticamente elenchi di righe di commento che contengono TODO.

— O. Jones
fonte

Visual Studio ha iniziato a fare // TODO: commenti quando ha aggiunto per la prima volta i generatori di codice per roba sulla piastra della caldaia MFC. Era la versione 2.0, iirc.

— mjfgates,

almeno per Visual Studio questa ricerca non fa distinzione tra maiuscole e minuscole - inserirà anche // todo foo nell'elenco delle attività

— jk.

4

Mi distingue ed è facile da catturare ... niente di complicato!

— bunglestink
fonte

1

è facile da trovare tramite grep o simili

— Zachary K,

@ZacharyK: esattamente!

— Dynamic

1

Richiama l'attenzione sul fatto che esiste un todo.

È importante che sia ovvio tutto il tempo che qualcuno deve tornare al codice. I dettagli devono solo essere conosciuti dalla persona che ritorna per affrontare qualunque sia il problema.

— yfeldblum
fonte

1

Se sei un utente vi usa:

/FARE

Ti ci porterà molto velocemente.

— ncmathsadist
fonte

Altri editor hanno funzionalità di ricerca e puoi cercare altrettanto facilmente todo .

— Karlson,

Tranne che "todo" potrebbe apparire in qualcos'altro come un nome di variabile o un altro testo di commento ...

— sevenseacat,

1

vi fa distinzione tra maiuscole e minuscole. Poiché i tappi sono usati con parsimonia nella maggior parte delle lingue moderne (in cose come le costanti nominate), la ricerca ha un'alta probabilità di successo.

— ncmathsadist,

1

Alcuni editor evidenziano solo le voci TODO maiuscole, quindi è più sicuro utilizzare sempre le maiuscole.

— Tim Abell
fonte

0

Visivamente TUTTI I CAPS si distingue, ma non è molto leggibile. Quando leggono il codice scansionano come un blocco di una dimensione particolare. 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 con distinzione tra maiuscole e minuscole avrà un tasso di falsi positivi molto basso su tutte le versioni di maiuscole. In alcuni stili di codifica c'è un piccolo rischio che una costante venga abbinata. La ricerca di maiuscole e minuscole rende i falsi positivi ancora meno probabili.

Una volta che lo strumento viene visualizzato sullo schermo, il formato dice chiaramente guarda QUI. Una volta che sei focalizzato sulla posizione, la parte leggibile sarà il commento correlato.

— BillThor
fonte