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

Question

多年来，我的代码充满了这样的评论：

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

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

Answer 1

您的IDE（Eclipse，NetBeans，..）有一个任务插件，可以检测所有TODO并在列表中显示它们。在Eclipse中它是Window > Show View > Other > Tasks

无需编写自己的注释。

Answer 2

TODO语句可能会永远留在代码中，这很糟糕，因为// TODO elaborate answer

Answer 3

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

• 短期项目的纸质记事本（如今天或本周）
• 针对较小的长期项目的TODO评论和IDE支持（例如Eclipse任务视图）
• 发布跟踪器，如Trac加IDE支持（例如Mylyn），用于更复杂，更长期的项目

Answer 4

对于vim，还有这个Tasklist脚本，受Eclipse的任务列表的启发，它在文本文件中擦除TODO，FIXME等，并将它们作为列表显示在额外的缓冲区中（参见{{3 }}）。

Answer 5

也许Doxygen可以帮到你？

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

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

Answer 6

我不会使用@todo javadoc注释，因为IMO不应该进入文档。
文档应 public ，不适合TODO TODO也应该接近它们所涉及的代码，这是使用注释的一个优点。

Answer 7

对于像我常见的// todo这样的小任务，我在Eclipse Mylyn中使用本地任务，对于更大的任务（即使我认为那些可能被称为功能或错误）我使用Trac;如果你发现你的代码已经满了TODO，那就得到一个票务管理系统了。

Answer 8

也许您可以使用find和grep在项目中搜索这些关键字

Answer 9

todo标志的问题与警告相同（例如java编译器，checkstyle）。如果它们经常出现，你会忽略它们。在你的情况下，我会通过构建系统（例如maven或ant）通过报告跟踪它们。在每次迭代结束时，你应该制定一个规则，todo标志的数量会减少。

较少的待办事项标志意味着：

• 解决他们
• 删除它们，因为它们已经过时（如果你从未整理过代码，通常会发生这种情况）

通常不要对所有任务使用todo标志。对我来说，他们只是一些提醒或重构 - todos。应该始终通过票证系统（如trac或jira）跟踪更大的任务。

Answer 10

我使用FIX！而不是TODO。感叹号的数量表示优先级。 IntelliJ允许你为这些设置自定义过滤器，所以我可以看看3级“FIX !!!”评论并解决这些问题。

Answer 11

如果您使用的是Maven，则可以使用taglist-maven-plugin扫描源文件中的标签（您想要的任何标签，这是可配置的）并在出现时生成a report。

  

Taglist Maven插件   生成各种标签的报告   在代码中找到，如@todo或   //TODO代码

但是跟踪标签很容易，修复它们会有点困难并需要更多时间：）

Answer 12

如果你的TODO语句错误地引起了你的注意并且在看到它们时引起了很大的焦虑，我会在构建过程中编写一个小脚本来检测并使编译失败。让它失败的方式与警告声明失败的方式相同。

Answer 13

TODO在一个小团队中很好，但如果您以任何方式开源项目或拓宽开发人员访问权限，其他变体如TO_DO，fixme，XXX，NOTE，HACK，bug，“your_defect_tool_here”等等都需要无论如何都要扫描。 有点重量级，但我的TODO协议看起来像：

TODO：YY-MM-DD：作者：your_comment

最后，让你做出的评论具有战略意义，而不是设计陈述或意见。