Is it rude to add "TODO: wtf?" in source code?
Posted
by mafutrct
on Stack Overflow
See other posts from Stack Overflow
or by mafutrct
Published on 2010-06-02T12:29:40Z
Indexed on
2010/06/02
12:33 UTC
Read the original article
Hit count: 248
I encountered something ... well, you know TDWTF... something like that in an international project I'm working on. The code was written by a team mate. For a second I was tempted to add // TODO: wtf?
to the infringing code but restrained myself.
The project is indeed on a professional level, but for internal conversation, more colloquial language is used - but still no "bad" words as in "wtf".
Usually, I'd surely not add such a comment, but I believe there are a few factors that allow consideration still: 1. It is not visible except as a comment in the source code (of course). 2. It is internal to our team - other developers may happen see it but it is not their code. 3. Comments in source code are usually accepted to be more colloquial, since it is "kept between us developers".
Would you totally advise to never add such a comment? Or do you regard it as an edge case? Did you possibly add something similar yourself?
© Stack Overflow or respective owner