GoLand 2025.2 Help

TODO 注释

有时,您需要标记代码的某些部分以供日后参考:需要优化和改进的区域、可能的更改、需要讨论的问题等。 GoLand 允许您添加特殊类型的注释,这些注释会在编辑器中 高亮显示 ,被索引并列在 TODO 工具窗口中。 这样,您和您的团队成员可以跟踪需要关注的问题。

TODO 注释示例

默认情况下,GoLand 能识别两个模式: TODOFIXME (不区分大小写)。 这些模式可用于任何受支持文件类型的行注释和块注释中。 您可以根据需要修改默认模式或 添加自定义模式

请使用所编程语言的标准注释样式编写 TODO。

创建多行 TODO 项

  • 请为多行注释中首行之后的注释行内容添加缩进。

    您可以使用空格、Tab 键,或两者的组合来缩进多行 TODO 项。

禁用多行 TODO 项

  1. Ctrl+Alt+S 打开设置,然后选择 编辑器 | TODO

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

查看 TODO 项

  • 打开 TODO 工具窗口: 视图(V) | 工具窗口 | TODO

用标签切换需要查看的 TODO 项来源:来自当前项目的所有文件、当前文件、特定 范围的文件,或 活动变更列表中的文件(如果已配置 版本控制集成)。

要跳转到源代码中的 TODO 注释,请在 TODO 工具窗口中单击相应的 TODO 项。 要禁用此行为,请点击工具栏中的 一键导航 按钮 单击导航按钮 (此时需要双击 TODO 项才能跳转到相应注释)。

添加自定义模式并筛选 TODO 项

您可以添加自定义模式,并筛选列表,仅显示与特定模式匹配的 TODO 项。 例如,您可以选择使用 OPTIMIZE 模式标记代码中可能需要优化的地方,在 TODO 工具窗口中查看时忽略其他类型的 TODO 项。

  1. 设置 对话框(Ctrl+Alt+S )中,选择 编辑器 | TODO

  2. 使用 正则表达式 来指定自定义模式。

    例如,要为注释中的 OPTIMIZE 一词添加模式,请点击 添加按钮 ,该按钮位于 模式 部分的 TODO 对话框中,并输入以下正则表达式:

    \boptimize\b.*

    此正则表达式匹配“optimize”一词(\b 表示词边界),并允许注释中包含任意多个其他字符。

    然后点击 确定(O) 以保存新模式。

  3. 添加筛选器以对 TODO 模式分组,并在 TODO 工具窗口中分别查看相应的 TODO 项。

    例如,要使用新模式添加 优化 筛选器,请点击 添加按钮 ,该按钮位于 筛选器 部分的 TODO 对话框中,指定 优化 作为名称并选择该新模式以包含在筛选器中。

    然后点击 确定(O) 以保存新筛选器。

  4. 点击 确定(O) 应用 TODO 设置对话框中的更改。

  5. 要应用新筛选器,请在 TODO 工具窗口中点击 筛选 TODO 项按钮 ,然后选择 优化 筛选器。

所选图标将显示在 TODO 工具窗口中,以便更好地区分各个 TODO 项。 启用某个模式的 区分大小写 复选框,表示该模式仅匹配指定大小写内容。

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