Synopsis: | Use TODO comments. |
Language: | Java |
Severity Level: | 7 |
Category: | Comments |
Description: |
Use TODO comments for code that is temporary, a short-term solution, or good-enough but not perfect. TODOs should include the string TODO in all caps, followed by a colon: // TODO: Remove this code after the UrlTable2 has been checked in. and
// TODO: Change this to use a flag instead of a constant. If your TODO is of the form "At a future date do something" make sure that you either include a very specific date ("Fix by November 2005") or a very specific event ("Remove this code after all production mixers understand protocol V7."). |
Literature References: |
Google Android Guidelines |