教程：使用语言模型 API 生成 AI 支持的代码注释

在本教程中，您将学习如何创建 VS Code 扩展来构建 AI 支持的代码导师。您将使用语言模型 (LM) API 生成建议来改进您的代码，并利用 VS Code 扩展 API 将其无缝集成到编辑器中，作为用户可以悬停以获取更多信息的内联注释。完成本教程后，您将了解如何在 VS Code 中实现自定义 AI 功能。

VS Code displaying custom annotations from GitHub Copilot as annotations

先决条件

您将需要以下工具和帐户才能完成本教程

搭建扩展

首先，使用 Yeoman 和 VS Code 扩展生成器搭建一个准备用于开发的 TypeScript 或 JavaScript 项目。

npx --package yo --package generator-code -- yo code

选择以下选项以完成新扩展向导...

# ? What type of extension do you want to create? New Extension (TypeScript)
# ? What's the name of your extension? Code Tutor

### Press <Enter> to choose default for all options below ###

# ? What's the identifier of your extension? code-tutor
# ? What's the description of your extension? LEAVE BLANK
# ? Initialize a git repository? Yes
# ? Bundle the source code with webpack? No
# ? Which package manager to use? npm

# ? Do you want to open the new folder with Visual Studio Code? Open with `code`

修改 package.json 文件以包含正确的命令

搭建的项目在 package.json 文件中包含单个“helloWorld”命令。此命令是在安装您的扩展后在命令面板中显示的内容。

"contributes": {
  "commands": [
      {
      "command": "code-tutor.helloWorld",
      "title": "Hello World"
      }
  ]
}

由于我们正在构建一个代码导师扩展，该扩展将向行添加注释，因此我们需要一个命令来允许用户打开或关闭这些注释。更新 command 和 title 属性

"contributes": {
  "commands": [
      {
      "command": "code-tutor.annotate",
      "title": "Toggle Tutor Annotations"
      }
  ]
}

package.json 定义了扩展的命令和 UI 元素，而 src/extension.ts 文件是您放置应为这些命令执行的代码的地方。

打开 src/extension.ts 文件，并将 registerCommand 方法更改为与 package.json 文件中的 command 属性匹配。

const disposable = vscode.commands.registerCommand('code-tutor.annotate', () => {

通过按 F5 运行扩展。这将打开一个安装了扩展的新 VS Code 实例。通过按 ⇧⌘P (Windows、Linux Ctrl+Shift+P) 打开命令面板，然后搜索“tutor”。您应该会看到“Tutor Annotations”命令。

The "Toggle Tutor Annotations" command in the VS Code Command Palette

如果您选择“Tutor Annotations”命令，您将看到一条“Hello World”通知消息。

The message 'Hello World from Code Tutor' displayed in a notification

实现“annotate”命令

要使我们的代码导师注释正常工作，我们需要向其发送一些代码并要求它提供注释。我们将分三步完成此操作

从用户打开的当前选项卡获取带行号的代码。
将该代码与自定义提示一起发送到语言模型 API，该提示指示模型如何提供注释。
解析注释并在编辑器中显示它们。

步骤 1：获取带行号的代码

要从当前选项卡获取代码，我们需要对用户打开的选项卡进行引用。我们可以通过将 registerCommand 方法修改为 registerTextEditorCommand 来实现。这两个命令之间的区别在于，后者为我们提供了对用户打开的选项卡的引用，称为 TextEditor。

const disposable = vscode.commands.registerTextEditorCommand('code-tutor.annotate', async (textEditor: vscode.TextEditor) => {

现在，我们可以使用 textEditor 引用来获取“可见编辑器空间”中的所有代码。这是可以在屏幕上看到的代码 - 它不包括位于可见编辑器空间之上或之下的代码。

在 extension.ts 文件底部 export function deactivate() { } 行正上方添加以下方法。

function getVisibleCodeWithLineNumbers(textEditor: vscode.TextEditor) {
  // get the position of the first and last visible lines
  let currentLine = textEditor.visibleRanges[0].start.line;
  const endLine = textEditor.visibleRanges[0].end.line;

  let code = '';

  // get the text from the line at the current position.
  // The line number is 0-based, so we add 1 to it to make it 1-based.
  while (currentLine < endLine) {
    code += `${currentLine + 1}: ${textEditor.document.lineAt(currentLine).text} \n`;
    // move to the next line position
    currentLine++;
  }
  return code;
}

此代码使用 visibleRanges 属性的 TextEditor 来获取当前在编辑器中可见的行的位置。然后它从第一行位置开始，移动到最后一行位置，将每一行代码添加到一个字符串中，连同行号一起。最后，它返回包含所有带有行号的可见代码的字符串。

现在，我们可以从 code-tutor.annotate 命令中调用此方法。修改命令的实现，使其看起来像这样

const disposable = vscode.commands.registerTextEditorCommand(
  'code-tutor.annotate',
  async (textEditor: vscode.TextEditor) => {
    // Get the code with line numbers from the current editor
    const codeWithLineNumbers = getVisibleCodeWithLineNumbers(textEditor);
  }
);

步骤 2：将代码和提示发送到语言模型 API

下一步是调用 GitHub Copilot 语言模型，并将用户的代码与创建注释的说明一起发送给它。

为此，我们首先需要指定要使用的聊天模型。我们在这里选择 4o，因为它是一个快速且功能强大的模型，适用于我们正在构建的交互类型。

const disposable = vscode.commands.registerTextEditorCommand(
  'code-tutor.annotate',
  async (textEditor: vscode.TextEditor) => {
    // Get the code with line numbers from the current editor
    const codeWithLineNumbers = getVisibleCodeWithLineNumbers(textEditor);

    // select the 4o chat model
    let [model] = await vscode.lm.selectChatModels({
      vendor: 'copilot',
      family: 'gpt-4o'
    });
  }
);

我们需要指令 - 或“提示” - 它将告诉模型创建注释以及我们希望响应的格式。将以下代码添加到文件顶部的导入下方。

const ANNOTATION_PROMPT = `You are a code tutor who helps students learn how to write better code. Your job is to evaluate a block of code that the user gives you and then annotate any lines that could be improved with a brief suggestion and the reason why you are making that suggestion. Only make suggestions when you feel the severity is enough that it will impact the readability and maintainability of the code. Be friendly with your suggestions and remember that these are students so they need gentle guidance. Format each suggestion as a single JSON object. It is not necessary to wrap your response in triple backticks. Here is an example of what your response should look like:

{ "line": 1, "suggestion": "I think you should use a for loop instead of a while loop. A for loop is more concise and easier to read." }{ "line": 12, "suggestion": "I think you should use a for loop instead of a while loop. A for loop is more concise and easier to read." }
`;

这是一个特殊的提示，指示语言模型如何生成注释。它还包括有关模型应如何格式化其响应的示例。这些示例（也称为“多轮”）使我们能够定义响应的格式，以便我们可以解析它并将其显示为注释。

我们将消息作为数组传递给模型。此数组可以包含任意数量的消息。在本例中，它包含提示以及带有行号的用户代码。

const disposable = vscode.commands.registerTextEditorCommand(
  'code-tutor.annotate',
  async (textEditor: vscode.TextEditor) => {
    // Get the code with line numbers from the current editor
    const codeWithLineNumbers = getVisibleCodeWithLineNumbers(textEditor);

    // select the 4o chat model
    let [model] = await vscode.lm.selectChatModels({
      vendor: 'copilot',
      family: 'gpt-4o'
    });

    // init the chat message
    const messages = [
      vscode.LanguageModelChatMessage.User(ANNOTATION_PROMPT),
      vscode.LanguageModelChatMessage.User(codeWithLineNumbers)
    ];
  }
);

要将消息发送到模型，我们首先需要确保选择了可用模型。这将处理扩展未准备就绪或用户未登录 GitHub Copilot 的情况。然后我们将消息发送到模型。

const disposable = vscode.commands.registerTextEditorCommand(
  'code-tutor.annotate',
  async (textEditor: vscode.TextEditor) => {
    // Get the code with line numbers from the current editor
    const codeWithLineNumbers = getVisibleCodeWithLineNumbers(textEditor);

    // select the 4o chat model
    let [model] = await vscode.lm.selectChatModels({
      vendor: 'copilot',
      family: 'gpt-4o'
    });

    // init the chat message
    const messages = [
      vscode.LanguageModelChatMessage.User(ANNOTATION_PROMPT),
      vscode.LanguageModelChatMessage.User(codeWithLineNumbers)
    ];

    // make sure the model is available
    if (model) {
      // send the messages array to the model and get the response
      let chatResponse = await model.sendRequest(
        messages,
        {},
        new vscode.CancellationTokenSource().token
      );

      // handle chat response
      await parseChatResponse(chatResponse, textEditor);
    }
  }
);

聊天响应以片段的形式出现。这些片段通常包含单个词，但有时它们只包含标点符号。为了在响应流入时显示注释，我们希望等到我们拥有完整的注释后才显示它。由于我们指示模型返回其响应的方式，因此我们知道当我们看到一个关闭的 } 时，我们就拥有了一个完整的注释。然后，我们可以解析注释并在编辑器中显示它。

在 extension.ts 文件中 getVisibleCodeWithLineNumbers 方法上方添加缺少的 parseChatResponse 函数。

async function parseChatResponse(
  chatResponse: vscode.LanguageModelChatResponse,
  textEditor: vscode.TextEditor
) {
  let accumulatedResponse = '';

  for await (const fragment of chatResponse.text) {
    accumulatedResponse += fragment;

    // if the fragment is a }, we can try to parse the whole line
    if (fragment.includes('}')) {
      try {
        const annotation = JSON.parse(accumulatedResponse);
        applyDecoration(textEditor, annotation.line, annotation.suggestion);
        // reset the accumulator for the next line
        accumulatedResponse = '';
      } catch (e) {
        // do nothing
      }
    }
  }
}

我们需要最后一种方法来实际显示注释。VS Code 将其称为“装饰”。在 extension.ts 文件中 parseChatResponse 方法上方添加以下方法。

function applyDecoration(editor: vscode.TextEditor, line: number, suggestion: string) {
  const decorationType = vscode.window.createTextEditorDecorationType({
    after: {
      contentText: ` ${suggestion.substring(0, 25) + '...'}`,
      color: 'grey'
    }
  });

  // get the end of the line with the specified line number
  const lineLength = editor.document.lineAt(line - 1).text.length;
  const range = new vscode.Range(
    new vscode.Position(line - 1, lineLength),
    new vscode.Position(line - 1, lineLength)
  );

  const decoration = { range: range, hoverMessage: suggestion };

  vscode.window.activeTextEditor?.setDecorations(decorationType, [decoration]);
}

此方法接收来自模型的已解析注释，并使用它来创建装饰。这是通过首先创建一个 TextEditorDecorationType 来完成的，它指定了装饰的外观。在本例中，我们只是添加一个灰色注释，并将长度截断为 25 个字符。当用户将鼠标悬停在消息上时，我们将显示完整消息。

然后，我们设置装饰应该出现在哪里。我们需要它出现在注释中指定的行号上，并且位于行的末尾。

最后，我们设置活动文本编辑器上的装饰，这会导致注释出现在编辑器中。

如果您的扩展仍在运行，请从调试栏中选择绿色箭头以重新启动它。如果您关闭了调试会话，请按 F5 运行扩展。在新打开的 VS Code 窗口实例中打开一个代码文件。当您从命令面板中选择“Toggle Tutor Annotations”时，您应该会看到代码注释出现在编辑器中。

A code file with annotations from GitHub Copilot

在编辑器标题栏中添加按钮

您可以启用您的命令，以便从命令面板以外的其他地方调用它。在本例中，我们可以在当前选项卡顶部添加一个按钮，允许用户轻松地打开或关闭注释。

为此，请修改 package.json 中的“contributes”部分，如下所示

"contributes": {
  "commands": [
    {
      "command": "code-tutor.annotate",
      "title": "Toggle Tutor Annotations",
      "icon": "$(comment)"
    }
  ],
  "menus": {
    "editor/title": [
      {
        "command": "code-tutor.annotate",
        "group": "navigation"
      }
    ]
  }
}

这会导致在编辑器标题栏的导航区域（右侧）出现一个按钮。“icon”来自产品图标参考。

使用绿色箭头重新启动您的扩展，或者如果扩展未在运行，请按 F5。您现在应该会看到一个注释图标，它将触发“Toggle Tutor Annotations”命令。

A comment icon appears in the title bar of the active tab in VS Code

下一步

在本教程中，您学习了如何创建 VS Code 扩展，该扩展使用语言模型 API 将 AI 集成到编辑器中。您使用 VS Code 扩展 API 从当前选项卡获取代码，使用自定义提示将其发送到模型，然后使用装饰器将模型结果解析并直接显示在编辑器中。

接下来，您可以扩展您的代码导师扩展以包含聊天参与者，这将允许用户通过 GitHub Copilot 聊天界面直接与您的扩展进行交互。您还可以探索 VS Code 中的全部 API，以探索在编辑器中构建自定义 AI 体验的新方法。

您可以在 vscode-extensions-sample 存储库中找到本教程的完整源代码。

10/29/2024