TODO Highlighter 插件

一个用于高亮显示代码中的TODO注释的VS Code插件。

功能特性

• 🔍 智能识别: 自动识别代码注释中的TODO、FIXME、BUG等关键字
• 🎨 语法高亮: 为不同类型的TODO注释提供不同的颜色高亮
• 🚫 避免误判: 只在注释中高亮，不会误判代码语句中的关键字
• ⚡ 实时更新: 文件修改时自动更新高亮效果

支持的TODO类型

• TODO: - 待办事项
• FIXME: - 需要修复的问题
• BUG: - 已知的bug
• HACK: - 临时解决方案
• NOTE: - 重要注释
• XXX: - 需要重构的代码

使用方法

插件安装后会自动工作，无需额外操作：

1. 自动高亮: 在代码注释中写入TODO关键字会自动高亮显示
2. 悬停提示: 鼠标悬停在高亮的TODO上会显示详细信息
3. 实时更新: 修改文件时高亮效果会自动更新

示例

// TODO: 需要实现这个函数的具体逻辑
function exampleFunction() {
    // FIXME: 这里有一个bug需要修复
    const result = 1 + 1;
    
    // NOTE: 这是一个重要的注释
    return result;
}

class ExampleClass {
    constructor() {
        // BUG: 构造函数中缺少参数验证
        this.name = "example";
    }
    
    method() {
        // HACK: 临时解决方案，需要重构
        return this.name;
    }
}

// XXX: 这个文件需要重构
export { exampleFunction, ExampleClass };

配置选项

在VS Code设置中可以配置以下选项：

• todoHighlighter.enabled: 是否启用TODO高亮功能
• todoHighlighter.patterns: 要匹配的TODO模式
• todoHighlighter.colors: 不同TODO类型的颜色

配置示例

{
  "todoHighlighter.enabled": true,
  "todoHighlighter.patterns": [
    "TODO:",
    "FIXME:",
    "BUG:",
    "HACK:",
    "NOTE:",
    "XXX:"
  ],
  "todoHighlighter.colors": {
    "TODO": "#ff8c00",
    "FIXME": "#ff0000",
    "BUG": "#ff0000",
    "HACK": "#ffff00",
    "NOTE": "#00ff00",
    "XXX": "#ff00ff"
  }
}

安装

1. 下载 .vsix 文件
2. 在VS Code中打开命令面板 (Ctrl+Shift+P)
3. 选择"扩展: 从VSIX安装..."
4. 选择下载的 .vsix 文件

开发

# 安装依赖
npm install

# 打包插件
vsce package

# 安装插件
code --install-extension todo-highlighter-0.1.0.vsix

许可证

MIT License