Take the 2-minute tour ×
Programmers Stack Exchange is a question and answer site for professional programmers interested in conceptual questions about software development. It's 100% free, no registration required.

TODO indicates "task to be completed", FIXME to be fixed etc. Is there a code tag to indicate "need improvement" on code comments?

share|improve this question

closed as not constructive by Walter, MichaelT, Blrfl, Yusubov, Glenn Nelson Feb 14 '13 at 19:22

As it currently stands, this question is not a good fit for our Q&A format. We expect answers to be supported by facts, references, or expertise, but this question will likely solicit debate, arguments, polling, or extended discussion. If you feel that this question can be improved and possibly reopened, visit the help center for guidance.If this question can be reworded to fit the rules in the help center, please edit the question.

    
    
"Clean Code" recommends not using any of them. –  user16764 Feb 14 '13 at 19:14
    
^ And when you are in the middle of the development? Theses tags are very useful. –  Felipe Micaroni Lalli Feb 14 '13 at 19:15
2  
@user16764 the PEP 350 document I linked to has a signficant list of objections to using them... violating DRY with the tracking tool being a very valid one. C2 on such comments FixmeComment along with TodoCommentsConsideredHarmful and TodoCommentsConsideredUseful –  MichaelT Feb 14 '13 at 19:19

1 Answer 1

up vote 4 down vote accepted

The closest thing to a document trying to standardize this is the Python PEP 350 - which was rejected as not a standard.

The Mnemonics section has a list of various ones used - I hesitate to call any of them "commonly used" beyond "TODO", "FIXME" and "XXX" (which are predefined in eclipse).

Going beyond this, it is local convention of that code base and team.


The new question - is there a "need improvement" type code tag. The best practice would to use the minimal set of tags. "TODO" indicates a task in the code. // TODO this code needs to be refactored would be sufficient rather than using another // RFE should refactor or // IDEA you know, we should refactor this. TODO is already recognized by Eclipse, by convention, by mylyn.

share|improve this answer
    
I change the question to be more specific about my problem. The right answer now is: RFE or IDEA according to python.org/dev/peps/pep-0350 –  Felipe Micaroni Lalli Feb 14 '13 at 20:55

Not the answer you're looking for? Browse other questions tagged or ask your own question.