VSCode怎么用快捷键快速插入TODO待办注释

阿敏酱_8375

阿敏酱_8375

2026-10-30

491人浏览

原创

Ctrl+Alt+T 插入 // TODO: 是最直接的方式;VSCode 默认未绑定该快捷键,但通过一行 JSON 配置即可启用,支持光标自动定位、避免拼写错误,适用于高频补漏场景。

vscode怎么用快捷键快速插入todo待办注释

Ctrl+Alt+T 插入 // TODO: 是最直接的方式

VSCode 默认不绑定该快捷键,但只需一行配置就能启用。它比手敲快、不拼错、光标自动停在冒号后,适合高频补漏场景。

操作步骤:

  • 按 Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(macOS),输入 Preferences: Open Keyboard Shortcuts (JSON) 并回车
  • 在打开的 keybindings.json 中粘贴以下内容(注意逗号分隔):
[
  {
    "key": "ctrl+alt+t",
    "command": "editor.action.insertSnippet",
    "args": {
      "snippet": "// TODO: $1"
    }
  }
]

保存后,任意编辑器中按 Ctrl+Alt+T 即可插入 // TODO: ,光标停留在冒号后供你直接输入内容。

常见错误现象:快捷键没反应 → 检查是否与其他插件冲突(如 Vim 插件会劫持 Ctrl+Alt+T);插入后多出换行 → 确保 $1 后没空格或多余字符。

用代码片段(todo + Tab)更灵活,支持语言限定

如果你只希望 todo 在 JavaScript 文件里触发,而在 Python 里不生效,代码片段比全局快捷键更可控。

配置方法:

  • 按 Ctrl+Shift+P,输入 Preferences: Configure User Snippets,选 javascript.json(或 global.code-snippets 做全局)
  • 添加如下片段:
{
  "TODO comment": {
    "prefix": "todo",
    "body": ["// TODO: $1"],
    "description": "Insert a TODO comment"
  }
}

之后在 JS 文件中输入 todo,按 Tab 即可展开。支持多光标:选中多行变量名后输入 todo + Tab,每行都会插入独立 // TODO:。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

容易踩的坑:prefix 必须全小写;若在 TypeScript 文件中失效,需单独配 typescript.json 或改用全局片段;$1 表示光标最终位置,别写成 $0(会跳走)。

别用块注释 /* TODO: */ 代替行注释 // TODO:

Todo Tree 和 TODO Highlight 这类主流插件默认只识别行级注释模式(// TODO:、# TODO:、; TODO:),对 /* TODO: */ 支持极弱——即使正则强行匹配,也会因跨行、嵌套、缩进等问题导致漏扫或误定位。

真实影响:

  • 侧边栏 Todo Tree 列表为空,你以为没配置好,其实是注释格式不被认
  • 搜索 TODO 时,Ctrl+Shift+F 默认忽略块注释区域(尤其在 JSX/TSX 中)
  • 团队协作时,CI 工具(如 eslint-plugin-todo)通常只校验行注释

例外情况:只有当你明确修改了 todo-tree.regex.regex 并加入 /*.*?TODO:/ 类正则,且确保无嵌套、无跨文件干扰,才可勉强用块注释。但维护成本远高于统一用 // TODO:。

插件不是必须的,但 Todo Tree 的三项配置必须加

装完 Todo Tree 插件后,侧边栏常为空——这不是插件坏了,而是默认配置太保守。

打开 settings.json,至少补这三行(缺一不可):

"todo-tree.tree.showTags": true,
"todo-tree.general.tags": ["TODO", "todo", "FIXME", "fixme", "NOTE", "note"],
"todo-tree.regex.regex": "((//|#|/\*|\*/|

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1475

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

3172

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

2069

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1747

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2627

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1858

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1282

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1136

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

534

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程