IfSQ

WIP-1—Vague "To Do"

Defect Indicators: There is a comment indicating that the programmer intends to add a piece of code, but has not specified an exact timeframe or reason, or other precise explanation.

For example, text such as the following are all indications that a program may be incomplete:

• “To Do”
• “Not Yet Implemented”
• “Action point”

Risks: A “To Do” may indicate missing functionality. In other words, the programmer has at some point decided that code needs to be written, but has not finished the work.

• If there is missing functionality, the problem may be found during testing and need to be fixed, or it may be found after the program goes into production, with unforeseen consequences, such as a crash or malfunction.
• If no code is actually required, a maintenance programmer may later waste time trying to determine whether it is required.

Assessment:

• Mark all of the lines of the comment block that contains the defect indicator.

Remedy:

• Add a comment explaining when the work needs to be done, and why, OR
• Do the work, OR
• Determine the work doesn’t need to be done and remove the comment.