2010-05-31 9 views
42

Welche Tokens finden Sie im Visual Studio nützlich? nur (Visual Studio 2010UmgebungAufgabenliste → Token)Token im Visual Studio: HACK, TODO ... andere?

hat derzeit i:

  • HACK-niedrig
  • REVIEW - hohe
  • TODO - Normal
  • WTF - hoch

(nur diese - gelöscht einige auch keine)

verwenden Sie anderen?

decken Sie alle anderen wichtigen Dinge mit Kommentar-Tokens?

Best Practices? thnx

+0

Sollte aufgenommen werden sollten. – Konerak

+7

für die hier landet nach der Aufgabenliste Tokens in Visual Studio, beachten Sie, dass die Menübefehle Visual Studio → Werkzeuge → Optionen → Umgebung → Aufgabenliste → Token – lib

Antwort

25

Hier ist die, die ich benutze:

  • ERLEDIGEN: die Funktionalität noch nicht
  • implementiert
  • FIXME: der Code geändert/Refactoring sollte ein bestimmtes Ziel (höhere Wartbarkeit, eine bessere Leistung zu erzielen und so weiter)
  • BUG: der Code hat einen Bug
+0

Ich mag Fixme und Bug :) Ich benutze Hack für Fixme. wird Bug hinzufügen! – b0x0rz

+2

Ich benutze das gleiche :) - Ich mache Unterkategorien für meine FIXME, das heißt: FIXME - Performance. – cwap

+0

Yup. Und TODO - ÜBERSETZEN. Wir verwenden Mantis # 123, um auf unser Bugtracking-System und die entsprechende Nummer zu verweisen. – Konerak

7

Ein weiteres eingebautes ist HINWEIS.

+4

ja, hat es nicht gefallen, da kein Kommentar ein HINWEIS ist irgendwie? – b0x0rz

+0

Einverstanden, aber ich versuche, Kommentare außer NOTE überhaupt nicht zu verwenden. Wenn ich noch etwas anderes habe, geht es in das Trackingsystem. In meinem Fall JIRA. –

+0

ah, ich sehe, ich benutze Kommentare ein bisschen mehr: P – b0x0rz

4

Vim hebt automatisch XXX hervor, was zufällig mein Token der Wahl für die Leichtigkeit der Eingabe ist.

Sun's (old) Java coding conventions haben folgendes zu sagen:

Verwenden XXX in einem Kommentar zu kennzeichnen etwas, das falsche ist, aber funktioniert. Verwenden Sie FIXME, um etwas zu markieren, das gefälscht und fehlerhaft ist.

+1

netter Tipp über vim. Ich wusste das nicht. – b0x0rz

21

Ich habe eine Kombination der meisten der oben genannten Tokens gemacht.

RED: code that simply does not work/compile 
// Error - This code is throwing a specific reproducible error. 
// Broken - This code is broken and will not run. 
// WTF - WHAT THE FRIG. 

ORANGE: code that works but is not right 
// Hack - This code has intentionally been hacked in order to work. Should not go into production. 
// FixMe - This code works but could be better. Needs better abstraction, maintainability, performance, etc. 
// Bug - This code works and was expected to be right but a bug has been found. (usually flagged post production) 
// Review - This code is probably right but should be reviewed for piece of mind. 
// Smells - Same as FixMe 

BLUE: code that works but either needs more features or more explaining 
// Todo - Functionality is not yet implemented 
// Note - Better explain what's going on. This is gives a higher profile to standard comments, and allows notes to be found in the to-do pane. 
+0

Ich benutze nicht unbedingt ALLES, aber abhängig von meiner Stimmung an diesem Tag, werde ich die Highlights auf die eine oder andere Weise bekommen. –

+0

Das ist eine coole Sache, wenn alle Mitarbeiter in Ihrem Unternehmen die gleichen Token markiert haben. Wenn es nicht nur macht Kommentare in einigen Fällen schwieriger zu verstehen. –

+0

Wie funktioniert Funktion _ noch nicht implementiert_, die funktioniert? –

6

Ich mag das Token ENTFERNT, was darauf hinweist, dass es nur in für die Prüfung, und nicht wahrscheinlich Community Wiki in der endgültigen Version

+4

Dies ist eine extrem schlechte Übung. Wenn der Code zum Testen verwendet wird, verwenden Sie die bedingte Kompilierung mit Präprozessordirektiven. – AMissico

+0

@AMissico aber '// REMOVE' ist einfacher – Gabriel

Verwandte Themen