WebStorm 2025.2 Help

TODO 注释

在开发应用程序时,您可能希望为代码的某些部分添加标记,以便将来参考:需要优化和改进的区域、可能的变更、需要讨论的问题等。 在 WebStorm 中,您可以添加在编辑器中 高亮显示并列在 TODO 工具窗口 中的特殊类型注释。

使用默认模式

默认情况下,WebStorm 会识别两个模式 —— 单词 TODOFIXME ,无论大小写。 这些模式可用于任何受支持的文件类型中的注释内。

使用 TODO 模式

创建 TODO 注释

  1. 将光标放置在希望创建 TODO 项的位置并添加注释,例如按下 Ctrl+/ ,然后输入 TODOFIXME ,接着输入您的备注。

  2. TODO 工具窗口中查看 TODO 项列表。 该工具窗口包含四个选项卡,WebStorm 会在其中分别显示整个项目、活动编辑器选项卡中的文件、所选范围或活动变更列表中的 TODO 项。

    • 默认情况下,选择某个条目后会自动跳转到源代码中的相应注释。 如需禁用此自动导航,请右键单击工具窗口标题,点击 查看选项 ,然后取消选中 单击导航

    • 禁用 单击导航 后,双击所需的 TODO 项即可跳转至源代码中的相应注释。

在 JavaScript 和 TypeScript 文件中,默认情况下 WebStorm 也支持多行 TODO 注释。 以常规方式使用 TODO 开始 TODO 注释,并在后续行添加缩进以延续 TODO 注释。 如果移除缩进,WebStorm 会将其视为普通注释。

多行 TODO 注释

抑制多行 TODO 注释

  1. 设置 对话框(Ctrl+Alt+S )中,点击 TODO ,位于 编辑器 下方。

  2. 在打开的 TODO 页面中,取消选中 将以下行中的缩进文本视为同一 TODO 的一部分 复选框。

使用自定义模式

您可以修改默认模式或添加自定义模式,并筛选列表,仅显示符合特定模式的 TODO 项。 例如,您可以使用 OPTIMIZE 模式标记需要优化的代码段,并忽略其他类型的 TODO 项。

创建自定义模式

  1. 设置 对话框(Ctrl+Alt+S )中,点击 TODO ,位于 编辑器 下方。 打开 TODO 页面

  2. 若要为 OPTIMIZE 项添加模式,请在 模式 区域点击 添加图标 ,并输入以下模式: \boptimize\b.*

  3. 若要使用新模式添加过滤器,请在 过滤器 区域点击 添加图标 ,指定新过滤器名称,并选择要包含的模式。

应用自定义过滤器

  • TODO 工具窗口中,点击 过滤 TODO 项 并选择所需过滤器。

最后修改日期: 2025年 9月 26日