Atom编辑器怎么做TODO管理_Atom编辑器todo-show教程【进阶】

冰火之心

冰火之心

2026-04-08

900人浏览

原创

todo-show插件默认仅匹配todo、fixme、hack、xxx开头的全大写注释,需检查正则规则、文件保存状态、项目根目录设置及gitignore影响;支持自定义关键词和正则,须保留两个捕获组;刷新依赖手动触发,团队应统一配置避免差异。

atom编辑器怎么做todo管理_atom编辑器todo-show教程【进阶】

Atom 编辑器本身不内置 TODO 管理功能,todo-show 插件是目前最稳定、可配置性最强的方案,但默认行为容易让人误以为“没生效”——问题通常出在正则匹配规则或项目根目录识别上。

为什么 todo-show 扫不出你的 TODO 注释

插件默认只扫描以 TODOFIXMEHACK 开头的全大写注释(如 // TODO: 修复空指针),不匹配 // todo/* Todo */ 或带空格/标点的变体。

  • 检查你写的标记是否符合默认正则:/(TODO|FIXME|HACK|XXX):?\s*(.*)$/i —— 注意末尾的 i 标志让它忽略大小写,但开头必须是这四个词之一
  • 确保文件已保存(未保存的缓冲区不会被扫描)
  • 确认当前打开的是项目根目录(右下角显示路径),否则插件可能只扫描单个文件而非整个工作区
  • 如果用了 gitignore,插件默认跳过被忽略的路径,可在设置里关掉 Ignore VCS Ignored Paths

自定义 TODO 关键词和匹配规则

想支持 // @review## BUG?直接改插件的 Custom Pattern 配置项,不用写代码。

  • 打开 Atom 设置 → Packages → 搜索 todo-show → 点 Settings
  • 找到 Custom Pattern 输入框,填入正则,例如:/(@review|## BUG|// NOTE):?\s*(.*)$/
  • 注意:正则中必须保留两个捕获组 —— 第一个匹配关键词(用于分类),第二个匹配描述内容;否则面板里看不到文字
  • 若想同时兼容大小写和常见拼写,可用:/(TODO|todo|Todo|FIXME|fixme|NOTE|note):\s*(.*)$/

todo-show 面板刷新不及时或路径错乱

这不是 Bug,而是插件为性能做的取舍:它不会监听文件实时变更,只在手动触发或切换标签页时重新扫描。

  • 快捷键 ctrl-alt-t(Windows/Linux)或 cmd-alt-t(macOS)强制刷新整个工作区
  • 右键某行调用 Todo: Toggle Todo 只刷新当前文件(适合临时增删)
  • 如果点击列表项打开错误文件,大概率是项目没设根目录 —— 在任意文件上右键 → Open in Project,或拖整个文件夹到 Atom 启动窗口
  • 禁用 Use Git Branch Filter(如果不需要按分支过滤),避免因 git 状态异常导致扫描中断

真正麻烦的不是配置,而是团队协作时每个人 regex 不一致,导致同一份代码在不同人机器上显示不同的 TODO 列表。上线前最好把 Custom Pattern 字符串写进项目 README 里,或者用 .todo-show.json 文件统一管理(插件支持该配置文件,优先级高于 UI 设置)。

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

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

下载

相关标签:

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

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

1563

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

1426

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

589

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

1338

7

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1155

5

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1236

5

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

2023.10.24

3287

49

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2023.11.24

2210

6

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

2024.03.22

3636

16

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.4万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 131.8万人学习