Comment Tags

The following are tags in all upper case that you might find in a comment in the source code.

tag	meaning
TODO	Unfinished implementation: not blocking release. Configure your IDE to make this a task
XXX	Unfinished implementation: in a commercial product this would block the release from going out, but this is Helios and we have lots of unfinished things in the product. Configure your IDE to make this a task. Hunt these down and eliminate when the bug queue is empty.
HACK	This code was a temporary hack and should not have been checked in. Typically used as XXX HACK.
WARNING	This code must not be changed casually or by machine (Resharper, variable renaming.) There are either non-obvious or unsafe implications to this code or dependencies on values elsewhere.
NOTE	This code may look incorrect to a casual reader. This message is important for understanding why this code is the way it is.
REVISIT	Documents a good idea how this code might be improved in the future. Not committed and hasn't been fully analyzed so could be wrong but probably is a good idea. Does not imply a task at this time.