2010-05-31 9 views
42

quels jetons trouvez-vous utiles dans le studio visuel? (visual studio 2010environnementliste des tâches → jetons)jetons en studio visuel: HACK, TODO ... un autre?

actuellement je ne dispose que:

  • HACK-faible
  • REVUE - haute
  • TODO - normale
  • WTF - haute

(seulement ces - supprimé certains ceux par défaut)

utilisez-vous d'autres?

couvrez-vous d'autres choses importantes avec des jetons de commentaire?

des meilleures pratiques? thnx

+0

devrait probablement être wiki communautaire. – Konerak

+7

pour qui atterrit ici à la recherche des jetons de liste des tâches dans Visual Studio, notez que les commandes de menu sont Visual studio → outils → options → environnement → liste des tâches → jetons – lib

Répondre

25

est ici ceux que j'utilise:

  • TODO: la fonctionnalité n'a pas encore été mis en œuvre
  • FIXME: le code doit être modifié/refondus pour atteindre un objectif (maintenabilité supérieur, une meilleure performance et ainsi de suite)
  • bOGUE: le code a un bug connu
+0

j'aime fixme et bug :) j'utilise hack pour fixme. va ajouter un bug! – b0x0rz

+2

J'utilise la même chose :) - Je fais des sous-catégories pour mes FIXME, à savoir: FIXME - Performance. – cwap

+0

Yup. Et TODO - TRADUIRE. Nous utilisons Mantis # 123 pour faire référence à notre système de suivi des bogues et au numéro correspondant. – Konerak

7

Un autre élément intégré est NOTE.

+4

ouais, n'a pas aimé depuis n'est pas un commentaire un NOTE en quelque sorte? – b0x0rz

+0

D'accord, mais j'essaie de ne pas utiliser de commentaires du tout, sauf pour NOTE. Si j'ai autre chose, cela va dans le système de suivi. Dans mon cas JIRA. –

+0

ah, je vois, j'utilise les commentaires un peu plus: P – b0x0rz

4

Vim met automatiquement en surbrillance XXX, qui se trouve être mon gage de choix pour la facilité de saisie.

Sun's (old) Java coding conventions ont ceci à dire:

Utilisez XXX dans un commentaire à quelque chose de drapeau qui est faux, mais fonctionne. Utilisez FIXME pour marquer quelque chose qui est faux et cassé.

+1

bonne astuce sur vim. Je ne le savais pas. – b0x0rz

21

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. 
+0

Je n'utilise pas nécessairement tous ces éléments, mais en fonction de mon humeur ce jour-là, je vais obtenir les faits saillants d'une façon ou d'une autre. –

+0

C'est plutôt cool si tous les employés de votre entreprise ont les mêmes jetons en évidence. Si cela ne rend pas les commentaires plus difficiles à comprendre dans certains cas. –

+0

Comment la fonction _functionality n'est pas encore implémentée_ code qui fonctionne? –

6

J'aime le jeton RETIRER, ce qui indique qu'il est seulement pour les tests, et ne devrait pas être inclus dans la version finale

+4

Ceci est une très mauvaise pratique. Si le code doit être testé, utilisez une compilation conditionnelle avec des directives de préprocesseur. – AMissico

+0

@AMissico mais '// REMOVE' est plus facile – Gabriel