Code Tagging
From dis-Emi-A
To help in maintaining code parts of the code should be marked with notices which indicate what needs to be done, what could be done, or what would be nice.
The tags should also have the form of "TAG: text..." on a single line (within a comment) with nothing trailing the text.
- TODO
- these items indicate that something is missing in the code, such that a particular use of the code could render invalid or unexpected results. Where possible they should be accompanied by an assert which will make clear the unexpected behaviour.
- FEATURE
- this is an idea for a feature that might be helpful around this code
- DEPRECATED
- this code supports a deprecated behaviour and can be planned for removal
- NOTE
- a special note of elevated significance within the comments, such notes must be read to use and/or modify the code
- SIGH
- used when the code works, but there is something just not right about it and you as the author already recognize it. It does not imply a defect, simply a style issue.
