Todo Comment (ARCH5183)

Key go.quality.todo-comment · Severity info · Category quality

TODO/FIXME/HACK/XXX markers document unfinished work and should be resolved before merge. They leave untracked debt in shipped code.

Incorrect

func ChargeCard(amount int) error {
    // TODO: wire the real payment provider
    // FIXME: amount validation missing
    return nil
}

Correct

func ChargeCard(amount int) error {
    if amount <= 0 {
        return errInvalidAmount
    }
    return paymentProvider.Charge(amount)
}

Fix

Finish the work the TODO describes, or open an issue and replace the comment with a reference to it.