A
fix me is a
CodeBadge in code (or a
WikiBadge in a wiki) that can be used to indicate where something is flawed or merely a stub in place of a real implementation. If you know how to fix it, replace the
FixMe with a fix. A
FixMe differs from a
CodeSmell in that the author of a
FixMe is 100% confident they know hoe to fix it. See also:
CodeSmell
A good
FixMe gives a thorough description of how to fix the problem. For example, a good code
FixMe would be:
# FIXME: Remove this function from the published interface; it is wholly private to this module.
and a
bad FixMe would be
# FIXME: this is nasty
--
CrawfordCurrie - 12 Apr 2004