Developers often add TODO
or FIXME
comments to code that is not complete or needs review.
It is a good idea to fix or review such commented code, and remove the comments before considering the code to be production-ready.
This issue is raised when comments starting with TODO:
, FIXME:
or STOPSHIP:
are found in the codebase.
If a Detekt configuration that specifies forbidden comment patterns is present, this issue will take that configuration into account.
// TODO: Fix this before shipping
fun someFunction() {
// ...
}
Address all the forbidden comments and remove them before shipping code to production.