IDE 注释关键字答案

【问题标题】：IDE comment keywordsIDE 注释关键字
【发布时间】：2012-03-24 02:17:26
【问题描述】：

所以我最近才发现 TODO 评论。对于那些不知道的人，大多数现代 IDE 都会在注释中识别这个词，并将注释行标记为不同的颜色，以便它脱颖而出。

EG。

//Need to talk to Bill about refactoring this code

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

您可能会注意到在 IDE 中，例如 Eclipse 或 Rubymine 会突出显示 TODO 注释和其他一些不错的功能。

我的问题是：还有哪些其他关键字类似于 TODO？通过 cmets 和一个应该在 IDE 中更广为人知的功能似乎是一种更好的方式与开发人员交流。毕竟他们的目的是帮助发展..

【问题讨论】：

FIXME: 的工作方式与 vim 中的 TODO: 非常相似。不完全是 IDE，但仍然... :)
可以确认FIXME也可以在eclipse中工作。听起来确实不错。那是2：D
只是一个小注解：在任务标签的末尾留下:。许多工具在定义之后添加它们，这在之后是一种噪音（特别是如果一些开发人员正在使用它，其中一些没有 - 例如，它会使 Tasks View 中的较旧的 Eclipse 版本）。

标签： eclipse ide comments rubymine todo

【解决方案1】：

我会说 Eclipse，你可以自定义它。

点击Window -> Preferences，然后搜索General -> Editors -> Structured Text Editors -> Task tags，或者搜索Java -> Compiler -> 任务标签（可能还有一些额外的标签，如 JavaScript、PHP、StatET 等）

TODO, FIXME, XXX

我使用了一些额外的，例如：

CHECKME, DOCME, TESTME, PENDING

我个人喜欢使用DISCUSS/REVIEW 标签，以确保我在代码审查或结对编程期间与某人谈论一些问题（例如，我没有误解规范应该如何工作等.).

您也可以在那里设置分配给不同任务标签的优先级。

【讨论】：

我添加了 ASSUMES 来捕捉非显而易见的先决条件。

【解决方案2】：

这些被称为task tags。在 Eclipse 中，它们是 TODO、FIXME 和 XXX。

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

在这里您可以修改任务标签的可用列表，更改它们的优先级，并决定任务标签是否应该区分大小写。

【讨论】：

【解决方案3】：

要在 IntelliJ 中添加自定义 TODO 标签，请转到：

首选项 > 编辑器 > TODO

【讨论】：

【解决方案4】：

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

【讨论】：

我知道这一点。我只是在寻找行业中普遍接受的或默认值的列表

【解决方案5】：

启用/禁用代码格式化程序使用： // @格式化程序：打开 // @formatter:off

【讨论】：

【解决方案6】：

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

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

【讨论】：