如何管理@todo编程的东西？

Question

多年来,我的代码充满了这样的评论:

//TODO : Add ...
...
/*
 *TODO : Fix ...
 *
 */

现在我想创建我自己的@todojavadoc注释...但在此之前我想知道你们是否有更好的方法来管理你的todo编程的东西？

Answer 1

您的IDE(Eclipse,NetBeans,..)有一个任务插件,可以检测所有TODOs并在列表中显示它们.在Eclipse中它是Window > Show View > Other > Tasks

无需编写自己的注释.

Answer 2

TODO语句存在永远留在代码中的风险,这很糟糕,因为 // TODO elaborate answer

Answer 3

我基本上使用三个系统用于不同类型的TODO项目:

• 用于短期物品的纸质记事本(如今天或本周)
• TODO注释以及IDE支持(例如Eclipse Tasks视图),用于较小的长期项目
• 发布跟踪器,如Trac加IDE支持(例如Mylyn),用于更复杂,更长期的项目

Answer 4

也许 Doxygen 可以帮助你？

Doxygen 识别这些 ///@TODO:s 并用它们创建一个列表。

由于 Doxygen 可以使用 Javadoc 样式的注释，我想尝试一下会很容易。

Answer 5

对于vim,还有这个Tasklist脚本,受Eclipse的任务列表的启发,它在文本文件中擦除TODO,FIXME等,并将它们作为列表显示在额外的缓冲区中(见截图).

Answer 6

我不会使用@todojavadoc 注释，因为 IMO 它不应该进入文档。
文档应该是公开的，不适合 TODO。
TODO 还应该靠近它们相关的代码，这是使用注释的一个优势。