VSCode TODO Highlight 扩展教程

VSCode TODO Highlight 扩展教程

vscode-todo-highlight VSCode Extension to highlight TODOs etc. 项目地址: https://gitcode.com/gh_mirrors/vsc/vscode-todo-highlight

1. 项目介绍

VSCode TODO Highlight 是一个 Visual Studio Code 扩展，用于高亮显示代码中的 TODO、FIXME 等注释标记。这个扩展可以帮助开发者在代码发布前更容易地发现和审查这些标记，从而避免遗漏重要的待办事项或修复项。

该项目最初由 wayou 维护，但在 2018 年似乎被放弃。随后，jgclark 在 2020 年接手并继续维护这个项目，增加了正则表达式支持并修复了一些问题。

2. 项目快速启动

安装

1. 打开 Visual Studio Code。
2. 按下 Ctrl+P 打开快速打开对话框。
3. 输入以下命令并按下回车：

   ext install jgclark.vscode-todo-highlight
   

配置

安装完成后，可以通过修改 settings.json 文件来自定义高亮设置。以下是一个简单的配置示例：

{
    "todohighlight.isEnable": true,
    "todohightlight.isCaseSensitive": true,
    "todohighlight.keywords": [
        "TODO:",
        "FIXME:",
        {
            "text": "NOTE:",
            "color": "blue",
            "backgroundColor": "rgba(0, 0, 0, 0)",
            "border": "1px solid blue",
            "borderRadius": "2px",
            "isWholeLine": false
        }
    ],
    "todohighlight.include": [
        "**/*.js",
        "**/*.jsx",
        "**/*.ts",
        "**/*.tsx",
        "**/*.html",
        "**/*.php",
        "**/*.css",
        "**/*.scss"
    ],
    "todohighlight.exclude": [
        "**/node_modules/**",
        "**/bower_components/**",
        "**/dist/**",
        "**/build/**",
        "**/.vscode/**",
        "**/.github/**",
        "**/_output/**",
        "**/*.min.*",
        "**/*.map"
    ],
    "todohighlight.maxFilesForSearch": 5120,
    "todohighlight.toggleURI": false
}

使用

在代码中添加 TODO、FIXME 或其他自定义标记，扩展会自动高亮显示这些标记。例如：

// TODO: 需要添加错误处理
function fetchData() {
    // 代码逻辑
}

// FIXME: 修复内存泄漏问题
function processData() {
    // 代码逻辑
}

3. 应用案例和最佳实践

应用案例

• 代码审查：在代码审查过程中，高亮显示的 TODO 和 FIXME 标记可以帮助审查者快速定位需要关注的代码部分。
• 项目管理：在大型项目中，开发者可以使用 TODO 标记来记录需要后续处理的代码片段，避免遗漏。

最佳实践

• 定期清理：定期审查并清理代码中的 TODO 和 FIXME 标记，避免积累过多无用的标记。
• 详细描述：在标记中添加详细的描述信息，帮助其他开发者理解标记的用途和背景。

4. 典型生态项目

• VSCode：作为 Visual Studio Code 的扩展，VSCode TODO Highlight 与 VSCode 紧密集成，提供了强大的代码高亮功能。
• GitHub：通过与 GitHub 集成，开发者可以在代码托管平台上直接查看高亮显示的标记，方便团队协作。
• GitLab：类似 GitHub，GitLab 也支持与 VSCode TODO Highlight 集成，提供代码标记的高亮显示功能。

通过以上步骤，您可以快速上手并充分利用 VSCode TODO Highlight 扩展，提升代码审查和项目管理的效率。

vscode-todo-highlight VSCode Extension to highlight TODOs etc. 项目地址: https://gitcode.com/gh_mirrors/vsc/vscode-todo-highlight