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

Visual StudioConfigurationToken

Visual Studio Problem Overview


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

Visual Studio Solutions


Solution 1 - Visual Studio

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

Solution 2 - Visual Studio

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.

Solution 3 - Visual Studio

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

Solution 4 - Visual Studio

Another built-in is NOTE.

Solution 5 - Visual Studio

Vim automatically highlights XXX, which happens to be my token of choice for the ease of typing it.

Sun's (old) Java coding conventions have this to say:

> Use XXX in a comment to flag something that is bogus but works. Use FIXME to flag something that is bogus and broken.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
Questionb0x0rzView Question on Stackoverflow
Solution 1 - Visual StudioEnrico CampidoglioView Answer on Stackoverflow
Solution 2 - Visual StudioChase FlorellView Answer on Stackoverflow
Solution 3 - Visual StudioKevinAView Answer on Stackoverflow
Solution 4 - Visual StudioTim LloydView Answer on Stackoverflow
Solution 5 - Visual StudioMark RushakoffView Answer on Stackoverflow