Skip to content

Files

Latest commit

 

History

History
30 lines (19 loc) · 750 Bytes

Generic.Commenting.Todo.md

File metadata and controls

30 lines (19 loc) · 750 Bytes

Pattern: Unresolved TODO comment

Issue: -

Description

Developers often add comments to code which is not complete or needs review. Most likely you want to fix or review the code, and then remove the comment, before you consider the code to be production ready.

Examples

Example of incorrect code:

// FIXME: this is not a good idea
// TODO: need code review
do_something_experimental();

Example of correct code:

// NOT READY FOR PRIME TIME
// but too bad, it is not a predefined warning term
do_something_experimental();

Further Reading