如何管理@todo编程内容？ [已关闭]

问题描述 投票：0回答：13

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

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

现在我想创建我自己的

@todo
javadoc注释......但在这样做之前我想知道你们是否有更好的方法来管理你的todo编程东西？

java javadoc project-management
13个回答
48
投票

您的 IDE（Eclipse、NetBeans 等）有一个任务插件，它可以检测所有 

TODO
并将它们显示在列表中。在 Eclipse 中是 
Window > Show View > Other > Tasks

在 Netbeans 中，它是 

Window > Action Items
(CTRL+6)

无需编写自己的注释。

41
投票

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

// TODO elaborate answer

14
投票

我基本上使用三个系统来处理不同类型的 TODO 项目：

  • 用于短期项目（例如今天或本周）的纸质记事本
  • TODO 注释以及针对较小、长期项目的 IDE 支持（例如 Eclipse 任务视图）
  • Trac 等问题跟踪器加上 IDE 支持（例如 Mylyn），适用于更复杂、更长期的项目
6
投票

也许 Doxygen 可以帮助你？

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

而且由于 Doxygen 可以使用 Javadoc 风格的注释，我想尝试起来很容易。

6
投票

我不会使用 

@todo
javadoc 注释，因为 IMO 它不应该进入文档。
文档应该是公开的，对于 TODO 来说并不理想。
TODO 还应该靠近它们相关的代码，这是使用注释的一个优点。

5
投票

对于 vim，还有这个 Tasklist 脚本，其灵感来自 Eclipse 的任务列表，它会在文本文件中抓取 TODO、FIXME 等内容，并将它们显示为额外缓冲区中的列表（请参阅屏幕截图）。

3
投票

我用的是FIX！而不是待办事项。感叹号的数量表示优先级。 IntelliJ 允许您为这些设置自定义过滤器，因此我可以查看第 3 级“FIX！！！”发表评论并解决这些问题。

3
投票

如果您使用 Maven，您可以使用 taglist-maven-plugin 扫描源文件中的标签（您想要的任何标签，这是可配置的）并生成 报告 其出现情况。

Taglist Maven 插件 生成有关各种标签的报告 在代码中找到，例如 

@todo
或 
//TODO
标签

但是跟踪标签是最简单的部分，修复它们有点困难并且需要更多时间:)

2
投票

对于小任务，比如我平常的 //todo，我使用 Eclipse Mylyn 中的本地任务，对于更大的任务（即使我认为这些可能被称为功能或错误），我使用 Trac；如果您发现您的代码充满了 TODO，那么是时候使用票证管理系统了。

2
投票

也许你可以使用 find 和 grep 来搜索项目中的这些关键字

2
投票

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

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

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

通常不要对所有任务都使用待办事项标志。对我来说，它们只是一些小提醒或重构待办事项。更大的任务应该始终通过票证系统（如 trac 或 jira）进行跟踪。

2
投票

TODO 在小团队中没问题，但如果您开源项目或以任何方式扩大开发人员访问权限，则需要扫描其他变体，例如 TO_DO、fixme、XXX、NOTE、HACK、bug、“your_defect_tool_here”等反正。 有点重量级，但我的 TODO 协议看起来像：

TODO：yy-mm-dd：作者：您的评论

最后，让您留下的评论具有战略意义，而不是设计声明或意见。

1
投票

如果您的 TODO 语句让您感到非常困扰，并在看到它们时让您感到非常焦虑，我会在构建过程中编写一个小脚本来检测编译并使其失败。让它以与警告语句失败相同的方式失败。

最新问题
© www.soinside.com 2019 - 2024. All rights reserved.