jetons dans le studio visuel: HACK, TODO ... un autre?

Question

ce que les jetons ne vous trouvez utiles dans visual studio? (visual studio 2010 → environnement → liste des tâches → jetons)

actuellement je n'ai que:

• HACK - bas
• REVUE - haut
• TODO - normal
• WTF - haut

(uniquement ces supprimé certains de ceux par défaut)

êtes-vous d'en utiliser d'autres?

êtes-vous couvrant tout autre chose importante, avec des commentaires de jetons?

toutes les meilleures pratiques? thnx

Answer 1

Voici ceux que j'utilise:

• TODO : la fonctionnalité n'est pas encore implémentée
• FIXME : le code doit être modifié / refactoré pour atteindre un objectif (facilité de maintenance accrue, meilleures performances, etc.)
• BOGUE : le code a un bug connu

Answer 2

J'ai fait une combinaison de la plupart des jetons ci-dessus.

  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.
 

Answer 3

J'aime le jeton REMOVE, indiquant qu'il est uniquement destiné aux tests et qu'il ne doit pas être inclus dans la version finale.

Answer 4

Une autre fonction intégrée est NOTE.

Answer 5

Vim met automatiquement en surbrillance XXX , ce qui est pour moi un gage de choix pour la facilité de le taper.

Les anciennes conventions de codage Java de Sun stipulent ceci:

Utilisez XXX dans un commentaire pour signaler quelque chose qui est faux mais qui fonctionne. Utilisez FIXME pour signaler quelque chose qui est faux et cassé.