Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

tokens in visual studio: HACK, TODO... any other? [closed]

what tokens do you find useful in visual studio? (visual studio 2010environmenttask list → tokens)

currently i have only:

  • HACK - low
  • REVIEW - high
  • TODO - normal
  • WTF - high

(only these - deleted some default ones)

are you using any others?

are you covering any other important thing with comment tokens?

any best practices? thnx

like image 225
b0x0rz Avatar asked May 31 '10 15:05

b0x0rz


4 Answers

Here's the ones I use:

  • TODO: the functionality is not yet implemented
  • FIXME: the code should be modified/refactored to achieve some goal (higher maintainability, better performance, and so on)
  • BUG: the code has a known bug
like image 170
Enrico Campidoglio Avatar answered Nov 16 '22 20:11

Enrico Campidoglio


I've done a combination of most of the above tokens.

 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.
like image 36
Chase Florell Avatar answered Nov 16 '22 18:11

Chase Florell


I like the Token REMOVE, indicating that it's only in for testing, and should not be included in the final release

like image 9
KevinA Avatar answered Nov 16 '22 19:11

KevinA


Another built-in is NOTE.

like image 7
Tim Lloyd Avatar answered Nov 16 '22 20:11

Tim Lloyd