Warum schreibt jeder To-Do-Kommentare in Großbuchstaben? [geschlossen]
9
Ich mache das gleiche. Wenn mein Code etwas "zu tun" enthält, schreibe ich //TODO .... Aber ich bin gespannt, wann dies begann und ob es einen Grund gibt, "Aufgaben" in Großbuchstaben zu schreiben?
Weil wir es wirklich BEDEUTEN (wir kommen einfach nie dazu)
Anthony Pegram
3
So können Redakteure sie markieren und durchsuchen lassen (z. B. die Aufgabenliste von Eclipse)
Ratschenfreak
6
Da Sie den Text im Code nicht fett formatieren konnten, brauchten Sie eine Möglichkeit, um wichtige Dinge hervorzuheben. Daher ...
Karlson
4
Warum spielt es eine Rolle?
Turm
3
Ich schreibe//todo:...
BЈовић
Antworten:
23
Es ist auch großartig, auf einfache Weise nach Codeabschnitten zu suchen, die Sie beschönigt haben und zu denen Sie zurückkehren möchten. Sie können nach "TODO" suchen, um sofort zu finden, was Sie zuvor übersprungen haben.
"todo" (Kleinbuchstaben) könnte möglicherweise Teil eines größeren Wortes / einer größeren Funktion / Variablen sein, "TODO" (Großbuchstaben) wird dies jedoch wahrscheinlich nicht sein.
Außerdem können Redakteure dies hervorheben. gedit macht es zum Beispiel und es macht es nur für alle Großbuchstaben TODO. Was auch immer der Grund sein mag, es ist genug Anreiz für mich, es in Großbuchstaben zu schreiben.
4
@delnan: Das ist eine Tautologie. Es wurde gemacht, um aufzufallen, also haben die Leute es benutzt, also hat jemand die Syntax-Hervorhebung in vim hinzugefügt, um mehr hervorzuheben, also haben die Leute es benutzt, um aufzufallen. Die Leute benutzen es nicht, weil der Editor es hervorhebt. Sie verwenden es, weil es üblich ist, dies zu tun, und daher macht der Editor es auffällig. Sie können alles in vim hervorheben, indem Sie die Syntaxhervorhebung entsprechend ändern. Es ist genauso einfach, hervorzuheben todo, aber es hat wenig Sinn, da die Konvention die Verwendung von TODO ist.
Martin York
1
@LokiAstari: Wie gesagt, ich schreibe es zum einen in Großbuchstaben, weil mehr Redakteure dies standardmäßig hervorheben. Aber vielleicht bin ich eine Ausnahme: Ziemlich jung (also hätte ich es nicht tun können, bevor die Redakteure es unterstützt haben) und (leider) zu viel Laune und Faulheit, um die Syntaxhervorhebung manuell anzupassen.
Auch schön für den armen Kerl, der nach Ihnen aufräumen muss, und für alle, die Ihren Code überprüfen müssen, bevor er vollständig ist. Sie können auf einen Blick sehen, was aufgrund dieser Konvention noch nicht getan wurde.
sq33G
2
Ich bin auf TODO in gemischten Groß- und Kleinschreibung innerhalb eines Variablennamens wie gestoßen filesToDownload. Natürlich behebt die Suche "nur ganze Wörter" dieses Problem.
Dan04
8
Ich bin neugierig zu wissen, wann dies begann und ob es einen Grund gibt, alles Kapital zu schreiben?
Die Idee mit Kommentaren wie TODO und FIXME ist, sie hervorzuheben. Sie möchten im Allgemeinen keinen Code mit solchen Markierungen im Code versenden - sie markieren Dinge, die zu tun sind, bevor das Projekt als abgeschlossen betrachtet werden kann. Die Verwendung von ALL CAPS erleichtert das Erkennen, vorausgesetzt, Sie verwenden ALL CAPS nicht für viele andere Dinge in Ihrem Code.
Sowohl Eclipse als auch Visual Studio verfügen über Aufgabenlistenfunktionen, mit denen Sie automatisch Listen mit Kommentarzeilen erhalten, in denen TODO enthalten ist.
Visual Studio hat mit den // TODO: -Kommentaren begonnen, als es zum ersten Mal die Codegeneratoren für MFC-Boilerplate-Inhalte hinzufügte. Das war Version 2.0, iirc.
mjfgates
Zumindest für Visual Studio unterscheidet diese Suche nicht zwischen Groß- und Kleinschreibung - es wird auch // todo foo in die Aufgabenliste aufgenommen
jk.
4
Ich stehe einfach hervor und ist leicht zu fangen ... nichts kompliziertes!
das und es ist leicht über grep oder ähnliches zu finden
Zachary K
@ ZacharyK: Genau!
Dynamisch
1
Es lenkt die Aufmerksamkeit auf die Tatsache , dass es existiert eine todo.
Es ist wichtig, dass immer klar ist, dass jemand zum Code zurückkehren muss. Die Einzelheiten müssen nur der Person bekannt sein, die zurückkommt, um das Problem zu lösen.
Andere Editoren verfügen über Suchfunktionen, und Sie können genauso einfach nach Aufgaben suchen .
Karlson
Außer 'todo' könnte in etwas anderem wie einem Variablennamen oder einem anderen Kommentartext erscheinen ...
sevenseacat
1
vi unterscheidet zwischen Groß- und Kleinschreibung. Da Großbuchstaben in den meisten modernen Sprachen (z. B. benannte Konstanten) sparsam verwendet werden, ist die Erfolgswahrscheinlichkeit bei der Suche hoch.
ncmathsadist
1
Einige Editoren markieren nur TODO-Elemente in Großbuchstaben, daher ist es sicherer, immer Großbuchstaben zu verwenden.
Optisch fällt ALL CAPS auf, ist aber nicht gut lesbar. Beim Lesen von Code scannen sie als Block einer bestimmten Größe. Es ist nicht wirklich wichtig, was die Buchstaben sind. Sie fallen einfach auf und sind sehr schnell zu sehen. Sobald Sie eine Weile mit den Tags gearbeitet haben, erkennt Ihr Gehirn das Wort an der Form.
Unter dem Gesichtspunkt der Tools (IDE / Editor) weist die Suche mit Groß- und Kleinschreibung bei allen Caps-Versionen eine sehr niedrige Falsch-Positiv-Rate auf. Bei einigen Codierungsstilen besteht ein geringes Risiko, dass eine Konstante übereinstimmt. Bei der Suche nach Groß- und Kleinschreibung wird die Wahrscheinlichkeit von Fehlalarmen noch geringer.
Sobald das Tool es auf den Bildschirm bringt, sagt das Format deutlich, dass Sie HIER schauen müssen. Sobald Sie sich auf den Ort konzentriert haben, ist der lesbare Teil der zugehörige Kommentar.
//todo:...Antworten:
Es ist auch großartig, auf einfache Weise nach Codeabschnitten zu suchen, die Sie beschönigt haben und zu denen Sie zurückkehren möchten. Sie können nach "TODO" suchen, um sofort zu finden, was Sie zuvor übersprungen haben.
"todo" (Kleinbuchstaben) könnte möglicherweise Teil eines größeren Wortes / einer größeren Funktion / Variablen sein, "TODO" (Großbuchstaben) wird dies jedoch wahrscheinlich nicht sein.
quelle
TODO. Was auch immer der Grund sein mag, es ist genug Anreiz für mich, es in Großbuchstaben zu schreiben.todo, aber es hat wenig Sinn, da die Konvention die Verwendung von TODO ist.filesToDownload. Natürlich behebt die Suche "nur ganze Wörter" dieses Problem.Die Idee mit Kommentaren wie TODO und FIXME ist, sie hervorzuheben. Sie möchten im Allgemeinen keinen Code mit solchen Markierungen im Code versenden - sie markieren Dinge, die zu tun sind, bevor das Projekt als abgeschlossen betrachtet werden kann. Die Verwendung von ALL CAPS erleichtert das Erkennen, vorausgesetzt, Sie verwenden ALL CAPS nicht für viele andere Dinge in Ihrem Code.
quelle
Sowohl Eclipse als auch Visual Studio verfügen über Aufgabenlistenfunktionen, mit denen Sie automatisch Listen mit Kommentarzeilen erhalten, in denen TODO enthalten ist.
quelle
Ich stehe einfach hervor und ist leicht zu fangen ... nichts kompliziertes!
quelle
Es lenkt die Aufmerksamkeit auf die Tatsache , dass es existiert eine todo.
Es ist wichtig, dass immer klar ist, dass jemand zum Code zurückkehren muss. Die Einzelheiten müssen nur der Person bekannt sein, die zurückkommt, um das Problem zu lösen.
quelle
Wenn Sie ein vi-Benutzer sind, verwenden Sie:
Es wird Sie sehr schnell dorthin bringen.
quelle
Einige Editoren markieren nur TODO-Elemente in Großbuchstaben, daher ist es sicherer, immer Großbuchstaben zu verwenden.
quelle
Optisch fällt ALL CAPS auf, ist aber nicht gut lesbar. Beim Lesen von Code scannen sie als Block einer bestimmten Größe. Es ist nicht wirklich wichtig, was die Buchstaben sind. Sie fallen einfach auf und sind sehr schnell zu sehen. Sobald Sie eine Weile mit den Tags gearbeitet haben, erkennt Ihr Gehirn das Wort an der Form.
Unter dem Gesichtspunkt der Tools (IDE / Editor) weist die Suche mit Groß- und Kleinschreibung bei allen Caps-Versionen eine sehr niedrige Falsch-Positiv-Rate auf. Bei einigen Codierungsstilen besteht ein geringes Risiko, dass eine Konstante übereinstimmt. Bei der Suche nach Groß- und Kleinschreibung wird die Wahrscheinlichkeit von Fehlalarmen noch geringer.
Sobald das Tool es auf den Bildschirm bringt, sagt das Format deutlich, dass Sie HIER schauen müssen. Sobald Sie sich auf den Ort konzentriert haben, ist der lesbare Teil der zugehörige Kommentar.
quelle