Best IT Recipes

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

which ones will you find in the visual studio? (visual studio 2010 → environment → task list → tokens)

Currently, I only have:

  • HACK - low
  • REVIEW - High
  • TODO - Normal
  • WTF - High

(only these - removed some by default)

Do you use any others?

Do you cover any other important thing with comment tokens?

any recommendations? Thnx

+39
visual-studio configuration token
May 31 '10 at 15:06
source share
5 answers

Here are the ones I use:

  • TODO : functionality not yet implemented.
  • FIXME : the code must be changed / reorganized to achieve a specific goal (higher maintainability, higher performance, etc.).
  • ERROR : code has known error
+24
May 31 '10 at 15:14
source share

I made a combination of most of the tokens listed.

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 going on. This is gives a higher profile to standard comments, and allows notes to be found in the to-do pane.
+19
Nov 02 2018-11-11T00:
source share

Another built-in - NOTE.

+7
May 31 '10 at 15:09
source share

I like the REMOVE token, indicating that it is only available for testing and should not be included in the final version

+5
Mar 08 '13 at 15:10
source share

Vim automatically highlights XXX , which turns out to be my sign of choice for ease of input.

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

Use XXX in the comment to mark something fictitious, but it works. Use FIXME to indicate something fictitious and broken.

+4
May 31 '10 at 15:18
source share


More articles:


All Articles