2012-03-06 49 views
31

所以我只是最近才发现了TODO评论。对于那些不知道的人来说,大多数现代IDE都会在注释中识别这个词,并将注释行标记为不同的颜色,因此它脱颖而出。IDE评论关键字

EG。

//Need to talk to Bill about refactoring this code 

//TODO:Need to talk to Bill about refactoring this code 

您可以在IDE的喜欢EclipseRubymine注意突出TODO注释和一些不错的其他功能,用它做。

我的问题是:还有什么其他关键字像TODO?这似乎是一种更好的方式,通过评论和一个应该在IDE中广为人知的特性与开发人员进行交流。他们的目的是为了帮助开发..

+3

'FIXME:'与VOD中的'TODO:'非常类似。不是一个IDE,但仍然... :) – cHao 2012-03-06 15:24:55

+1

可以确认FIXME也在eclipse中工作。听起来不错。那是2:D – OVERTONE 2012-03-06 15:25:33

+1

只是一个小方面的说明:离开任务标签末尾的':'。许多工具在定义之后添加它们(特别是如果某些开发人员正在使用它们,其中一些则不是 - 例如,它在较旧的Eclipse版本中会混淆* Tasks View *)。 – rlegendi 2012-03-07 08:03:26

回答

52

我可以说Eclipse,你可以自定义它。

点击窗口 - >首选项,并搜索常规 - >编辑 - >结构化文本编辑器 - >任务标记,或爪哇 - >编译器 - >任务标记(可能会有一些额外的那些象为JavaScript,PHP,StatET等)

TODO, FIXME, XXX 

我使用一些额外的像:

CHECKME, DOCME, TESTME, PENDING 

我个人比较喜欢到u请输入DISCUSS/REVIEW标签,以确保我在代码审查或配对编程期间与某人讨论某个问题(例如,我没有误解说明应该如何工作等)。

您还可以设置优先也分配给不同的任务标签。

+1

我添加了ASSUMES来捕捉非明显的先决条件。 – rimsky 2015-07-22 22:54:58

8

这些被称为task tags。在Eclipse中,它们是TODO,FIXMEXXX

但是,Eclipse允许您修改任务标签的可用列表。转到preferences>Java>Compiler>Task Tags

在这里,您可以修改任务标记的可用列表,改变自己的优先级,并决定是否任务标记应区分大小写。

1

像TODO,FIXME这样的模式在NetBeans中默认为ToDo关键字。您还可以在工具>选项>杂项>任务中添加所需的任何关键字。

+0

我知道这一点。我只是在寻找一个普遍接受的列表或默认的indstry – OVERTONE 2012-03-06 15:34:34

1

启用/禁用代码格式化使用: // @formatter:上 // @formatter:关

0

添加自定义标签TODO的IntelliJ去:

首选项>编辑器> TODO

1

在Eclipse Oxygen 4.7.2 for C/C++中,任务标签在Windows - >首选项 - > C/C++ - >任务标签中配置。

您还可以启用搜索任务标记为@rlegendi答案。