开发者

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

开发者 https://www.devze.com 2023-01-01 22:17 出处:网络
As it currently stands, this question is not a good fit for our Q&A format. We expect answers to be supported by facts, references,or expertise, but this question will likely solicit debate, a
As it currently stands, this question is not a good fit for our Q&A format. We expect answers to be supported by facts, references, or expertise, but this question will likely solicit debate, arguments, polling, or extended discussion. If you feel that this question can be improved and possibly reopened, visit the help center for guidance. Closed 9 years ago.

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


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


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.


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


Another built-in is NOTE.


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.

0

精彩评论

暂无评论...
验证码 换一张
取 消