TODO 列表
JetBrains Rider 提供了一种简单的方法来跟踪任务和代码中的 技术债务——匹配 特定模式的代码项(注释、字符串字面量或标识符)可以在编辑器中以及整个解决方案中通过 TODO 窗口轻松定位。

TODO 项目会根据其类型(编辑、普通、问题、警告、错误)在编辑器和 错误标记 上高亮显示。 颜色可以在 编辑器 | TODO 设置页面  Ctrl+Alt+S 上配置。
TODO 模式
默认情况下,JetBrains Rider 提供了三种预定义模式,用于常用的 TODO 项目,类型如下:
注释中包含
TODO或TODO:一些描述的行(不区分大小写) - 普通注释中包含
BUG:的行(区分大小写) - 错误代码中的
NotImplementedException- 编辑
您还可以定义自己的模式,以便能够快速访问 TODO 窗口中的特定技术债务项目。
定义自定义 TODO 模式
打开 JetBrains Rider 设置 的 页面 Ctrl+Alt+S。
点击 添加 工具栏。
使用您希望在注释中检测到的关键字指定正则表达式。 例如,
(\W|^)(?<TAG>Refactor)(\W|$)(.*)。可选地,指定模式是否区分大小写。
为模式选择一个图标,以定义匹配项在编辑器和 TODO 窗口中的颜色显示方式。
单击 确定 将此模式添加到列表中。
您还可以编辑或删除现有模式。
在 设置 对话框中点击 保存 以应用修改,并让 JetBrains Rider 选择保存位置,或者通过从 保存 选择器中选择特定设置层来保存修改。 如需了解更多信息,请参见 基于层的设置。
注释中的多行 TODO 项目
默认情况下,如果后续行相对于第一行至少缩进一个空格,注释中的 TODO 项目可以是多行的:
如果您希望注释中的 TODO 项目仅为单行,可以在 JetBrains Rider 设置 的 页面上清除 将后续行的缩进文本视为同一 TODO 的一部分 Ctrl+Alt+S。
在 TODO 项目之间导航
要在当前文件中导航 TODO 项目,请使用 错误标记 上的 TODO 标记。
研究整个解决方案中的 TODO 项目
按 Alt+6 或在主菜单中选择 。
在打开的 TODO 窗口中,单击
或
以导航到下一个或上一个项目。要在编辑器中定位 TODO 项目,请双击它们,按 F4 或在上下文菜单中选择 跳转到源。
可选地,您可以启用 一键导航
,以便项目在工具窗口中获得焦点时立即在编辑器中定位。
要在窗口中直接研究选定项目的源代码,请单击工具栏上的 预览源代码
。
分组和筛选 TODO 项目
根据代码库的大小和历史,可能会有许多 TODO 项目。 要专注于特定项目,您可以通过 范围 或自定义筛选器筛选 TODO 项目。
初步筛选可以通过 TODO 窗口的选项卡完成:
您可以使用 当前文件 选项卡仅查看编辑器中活动文件的 TODO 项目。
当您为当前解决方案启用 VCS 集成 时, 默认更改列表 选项卡将变为可用;此选项卡将列出具有未提交本地更改的文件中的 TODO 项目。
在 基于作用域 选项卡中,我们可以使用 范围 选择器选择 Rider 应该搜索 TODO 项目的位置。 您还可以单击 … 创建您自己的 范围。
进一步的筛选可以通过自定义筛选器实现,这些筛选器允许您创建感兴趣的 TODO 模式 组。
您可以在 JetBrains Rider 设置 的 页面 Ctrl+Alt+S 创建自定义筛选器,或在 TODO 窗口中单击筛选器图标 并选择 编辑筛选器。
TODO 窗口控件
要在工具窗口选项卡中循环切换,请按 Alt+Right 和 Alt+Left。
工具栏按钮
图标 | 工具提示和快捷键 | 描述 |
|---|---|---|
上一个 TODO Ctrl+Alt+Up | 选择列表中的上一个 TODO 项目。 | |
下一个 TODO Ctrl+Alt+Down | 选择列表中的下一个 TODO 项目。 | |
筛选 TODO 项目 | 选择筛选器或打开 TODO 对话框 ,您可以在其中根据需要编辑 TODO 模式和筛选器列表。 | |
一键导航 | 当启用此开关时,您可以点击项目以在编辑器中打开项目。 否则,您可以通过双击它们或按 F4 来在编辑器中定位项目。 | |
全部展开 Ctrl+NumPad Plus | 点击此按钮展开所有节点。 | |
全部收起 Ctrl+NumPad Minus | 点击此按钮可折叠所有节点。 | |
按项目分组 | 使用此切换来按包含的项目分组 TODO 项目。 不适用于 当前文件 选项卡。 | |
预览源代码 | 显示一个预览窗格,展示所选项目在相应文件中的源代码。 |
上下文菜单
条目 | 描述 |
|---|---|
跳转到源 F4 | 跳转到源代码中相关注释的位置。 仅当您右键点击 TODO 项或文件时可用。 |
本地历史记录 | 显示 本地历史记录 子菜单:
|