Haha I love the "Zombie code ๐งโโ๏ธ" term!!!
About 4. I would say that a comment is not bad if prefixed with // TODO:. Even maybe better if the todo reference an issue in the tracker as you suggest.
// @TODO for things that should be improved/refactored in the future. // @FIXME for things that are in a broken/buggy state.
There is a risk that nobody will ever look at these comments again and they remain there to rot in the codebase. This works best if you add a ticket number from your issue tracker (Jira/GitHub issues) so any developer can find context information about it, so:
// @FIXME #321: Temporary fix for XYZ, remove when this ticket is done
@alexanderjanke
: Haha I might use the // HACK: way more often than it should be allowed ๐ . Thanks for feedback, might probably gonna try to enrich my todos with these ideas.
@ekeijl
: Agree with you, works best with a ticket number, if not even a must
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
Haha I love the "Zombie code ๐งโโ๏ธ" term!!!
About 4. I would say that a comment is not bad if prefixed with
// TODO:
. Even maybe better if the todo reference an issue in the tracker as you suggest.Thank for the share ๐
I got used to using
// FIXME:
for these scenarios so they stick out. A bug should be higher prio than a normal todo in my opinionOh pretty cool tips and tricks ๐
Do you use
// TODO:
and// FIXME:
"only" or any other granularity?// @TODO
for things that should be improved/refactored in the future.// @FIXME
for things that are in a broken/buggy state.There is a risk that nobody will ever look at these comments again and they remain there to rot in the codebase. This works best if you add a ticket number from your issue tracker (Jira/GitHub issues) so any developer can find context information about it, so:
// @FIXME #321: Temporary fix for XYZ, remove when this ticket is done
I use this one here marketplace.visualstudio.com/items...
Apart from TODO and FIXME I also use
// HACK:
๐ That's about it@alexanderjanke : Haha I might use the
// HACK:
way more often than it should be allowed ๐ . Thanks for feedback, might probably gonna try to enrich my todos with these ideas.@ekeijl : Agree with you, works best with a ticket number, if not even a must