Alternatives to TODO in Java [closed]

Question

Closed. This question is off-topic. It is not currently accepting answers.

---

Want to improve this question? Update the question so it's on-topic for Stack Overflow.

Closed 8 years ago.

Improve this question

I have a colleaugue who gets upset whenever I use TODOs in my code. Is there an alternative, such as INFO or NOTE that will not disturb his sensitive sensibilities, and allow my outstanding tasks to display in the Eclipse Task Panel?

Answer 1

You can make your own tags in eclipse. I would suggest making one like INFO or NOTE and then using that. These new tags will show up in the Tasks menu just like TODO.

Location: Preferences > Java > Compiler > Task tags

Answer 2

Tell him to grow up. Seriously. Why should other devs have to abandon a perfectly good practice, just because he doesn't like it?

Answer 3

Create a failing unit test and add the @Ignore annotation to it. Or add a pending cucumber or easyb test.

Probably still bad that it isn't complete but at least you would be adding some unit test coverage when you got back to the outstanding issue.

Answer 4

Code is not the place to keep track of this -- if you want want to do it, put it in whatever project management software you are using and let people prioritize appropriately.

Answer 5

It's of course a matter of personal preference, but I'd say a list separate from the code can be a better idea.

Some sort of shared document could work. Or an issue tracker - sounds pretty much exactly like what they were made for.

Advantage: Doesn't clutter the code as TODO's tend to do.

Disadvantage: Having a direct link to where change needs to happen, regardless of other changes to code, can be difficult to do.

Some combination of both TODO's and a list separate from the code may be the way to go.