This is a basic CODE comment that is meant to be PERMANENT. It is mostly used to describe what a single line or block of code is doing.
Action Items should NEVER be in a basic code comment, and should ALWAYS be tagged with one of the following prefixes:
FN - Function or Method - Title and Description
NOTE - This is more than a code comment, and is something to always keep in mind when touching this code
UPDATE - This is an UPDATE to a previous Note, ToDo or FixMe
TODO - This still needs to be implemented
ALERT - This is NOT broken, but needs to be addressed ASAP
FIXME - This is BROKEN CODE, and needs to get fixed ASAP
Loading...