以某种方式转义 IntelliJ IDEA 中的 Todo 关键字

Question

我正在开发一个用于管理 Todo 任务的 Web 应用程序示例（在 Java 中）。因此我有一个名为 Todo 的实体，显然在许多评论中我使用 Todo 词来指代我的 Todo 实体（而不是关于代码的 TODO 项目），例如

/**
 * Todo entity model.
 */
@Entity
public class Todo {

结果我收到来自 IntelliJ IDEA 的警告

Warning:(*, 2) Complete the task associated to this TODO comment.

我已经尝试使用 {@code Todo} 和 {@literal Todo}，但警告并没有消失。如何转义 Todo 关键字以消除来自 IDEA 的警告？

Answer 1

您可以更改 IDEA 的待办事项设置 ...

文件 -> 设置 -> 编辑器 -> TODO - 调整 \btodo\b.* 条目：删除它或更改为大写并启用区分大小写的选项。

Answer 2

我的建议是更改用于匹配 Intellij 中的 TODO 的正则表达式，以防止匹配那些 Todo 位于大括号之间的情况。考虑以下示例：

/**
 * {@code org.reminder.Todo}
 * Todo this is the only matching TODO task
 * NotaTODO in this line
 *
 */

以下 TODO 正则表达式（在菜单文件 -> 设置 -> 编辑器 -> TODO 中）将在任何情况下匹配所需的 TODO：

\btodo(\b[^}]).*

有关 Intellij IDEA 正则表达式的更多说明，请访问 Intellij IDEA- Regular Expression Syntax Reference。

Escaping someway the Todo keyword in IntelliJ IDEA