Menu
For many years my code was full of this kind of comments :
//TODO : Add ... ... /* *TODO : Fix ... * */ Now I think to create my own @todo javadoc annotation ... but before doing that I want to know if do you guys have better way to manage your todo programming stuff ?
455
TODO comments are just code comments that start with a single string of capital letters like // TODO or // FIXME. Most of the TODO comments in your code are probably sitting unattended and forgotten in your team or organization's source code.
TODO — something to be done. NOTE — used to highlight especially notable gotchas. UNDONE — a reversal or "roll back" of previous code. XXX — warn other programmers of problematic or misguiding code.
In general, a TODO is written to tell future maintainers about something important: something that should be added, or should be changed, or should not be forgotten. The intention is often to increase the quality of the code. Sometimes a TODO comment can save you a lot of time!
Your IDE (Eclipse, NetBeans, ..) has a tasks plugin, which detects all TODOs and shows them in a list. In Eclipse it's Window > Show View > Other > Tasks
No need to write your own annotation.
155
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
