VSCode编辑器装饰_文本标记与行内提示实现-VSCode-PHP中文网

VSCode编辑器装饰_文本标记与行内提示实现

幻影之瞳

发布： 2025-11-18 14:52:02

原创

819人浏览过

文本标记和行内提示可提升VSCode代码可读性与交互体验。1. 文本标记通过createTextEditorDecorationType定义样式，如高亮未使用变量、TODO注释等，并用setDecorations应用到指定范围；2. 行内提示需注册onInlineHintsProvider，在代码行尾显示类型推断、返回值等轻量信息；3. 应优化性能，仅在活动编辑器应用装饰，使用防抖、分块处理，避免影响大文件编辑；4. 提示内容应简洁，兼容主题，结合LSP语义分析实现精准展示。

vscode编辑器装饰_文本标记与行内提示实现

在 VSCode 中，通过扩展开发可以实现丰富的编辑器功能，其中 文本标记（Decorations） 和 行内提示（Inline Hints） 是提升代码可读性和交互体验的重要手段。它们可以帮助开发者高亮特定代码、添加上下文信息，甚至提供实时建议。

文本标记（Decorations）

VSCode 的装饰系统允许你在编辑器中为文本范围添加视觉样式，比如背景色、边框、下划线或前后缀图标等。这类功能常用于：

标记未使用的变量
高亮 TODO 注释
显示代码覆盖率
语法问题提示（非诊断）

实现方式主要依赖 window.createTextEditorDecorationType 创建装饰类型，并使用 TextEditor.setDecorations 应用到指定编辑器的文本范围内。

示例代码：

const decorationType = vscode.window.createTextEditorDecorationType({
  backgroundColor: '#ff000020',
  border: '1px dashed #f00',
  after: {
    contentText: ' ← 需要检查',
    color: '#999'
  }
});

const editor = vscode.window.activeTextEditor;
const range = new vscode.Range(0, 0, 0, 10); // 第一行前10个字符
editor.setDecorations(decorationType, [range]);

你可以根据语言、正则匹配或语义分析动态生成多个 range 并批量应用装饰。

行内提示（Inline Hints）

行内提示是 VSCode 1.82+ 引入的功能，用于在代码行尾显示轻量级建议信息，类似 TypeScript 的参数提示。它适用于：

ImgCleaner

一键去除图片内的任意文字，人物和对象

220

查看详情

显示变量类型推断
函数返回值预览
调试值注入
国际化键名提示

实现需注册 vscode.onInlineHints 事件，并返回 InlineHint 数组。

示例代码：

vscode.languages.registerInlineHintsProvider('javascript', {
  provideInlineHints(document, range, token) {
    const hints = [];
    const text = document.getText(new vscode.Range(range.start.line, 0, range.start.line, 50));
    if (text.includes('count')) {
      hints.push(new vscode.InlineHint(
        'number',
        new vscode.Range(range.start.line, 10, range.start.line, 10)
      ));
    }
    return hints;
  }
});

用户可在设置中控制是否显示 inline hints，也可以通过快捷键触发刷新。