教程：使用语言模型 API 生成由 AI 驱动的代码批注
在本教程中，你将学习如何创建一个 VS Code 扩展来构建一个由 AI 驱动的代码导师（Code Tutor）。你将使用语言模型 (LM) API 生成改进代码的建议，并利用 VS Code 扩展 API 将其无缝集成到编辑器中，作为内联批注供用户悬停查看更多信息。完成本教程后，你将知道如何在 VS Code 中实现自定义 AI 功能。
前提条件
完成本教程需要以下工具和账户
搭建扩展骨架
首先，使用 Yeoman 和 VS Code Extension Generator 搭建一个准备好开发的 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" command 命令。当安装了你的扩展时，这个命令会显示在命令面板中。
"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" 命令。
如果你选择 "Tutor Annotations" 命令，你将看到一个 "Hello World" 通知消息。
实现 "annotate" 命令
为了让我们的代码导师批注功能正常工作，我们需要向其发送一些代码并要求它提供批注。我们将分三步完成此操作
- 从用户当前打开的选项卡获取带有行号的代码。
- 将该代码连同指导模型如何提供批注的自定义提示词一起发送给语言模型 API。
- 解析批注并在编辑器中显示它们。
第一步：获取带有行号的代码
为了从当前选项卡获取代码，我们需要对用户打开的选项卡的引用。我们可以通过将 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;
}
此代码使用 TextEditor 的 visibleRanges 属性来获取编辑器中当前可见的行的位置。然后，它从第一行位置开始，移动到最后一行位置，将每一行代码连同其行号一起添加到字符串中。最后，它返回包含所有带有行号的可视代码的字符串。
现在我们可以从 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);
}
);
第二步：将代码和提示词发送给语言模型 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." }
`;
这是一个特殊的提示词，用于指导语言模型如何生成批注。它还包含有关模型应如何格式化其响应的示例。这些示例（也称为“多样本/multi-shot”）使我们能够定义响应的格式，以便我们可以对其进行解析并将其显示为批注。
我们以数组形式向模型传递消息。这个数组可以包含任意数量的消息。在我们的例子中，它包含提示词，后跟带有行号的用户代码。
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 将这些称为“装饰（decorations）”。在 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" 时，你应该会看到代码批注出现在编辑器中。
在编辑器标题栏中添加一个按钮
你可以使你的命令能够从命令面板之外的地方调用。在我们的例子中，我们可以在当前选项卡的顶部添加一个按钮，允许用户轻松切换批注。
为此，请按如下方式修改 package.json 的 "contributes" 部分
"contributes": {
"commands": [
{
"command": "code-tutor.annotate",
"title": "Toggle Tutor Annotations",
"icon": "$(comment)"
}
],
"menus": {
"editor/title": [
{
"command": "code-tutor.annotate",
"group": "navigation"
}
]
}
}
这会使一个按钮出现在编辑器标题栏的导航区域（右侧）中。“图标”来自产品图标参考。
使用绿色箭头重新启动扩展，或者如果扩展尚未运行，请按 F5。你现在应该会看到一个评论图标，它将触发 "Toggle Tutor Annotations" 命令。
后续步骤
在本教程中，你学习了如何创建一个 VS Code 扩展，该扩展通过语言模型 API 将 AI 集成到编辑器中。你使用 VS Code 扩展 API 从当前选项卡获取代码，将其与自定义提示词一起发送给模型，然后使用装饰器在编辑器中解析并显示模型结果。
接下来，你可以扩展你的代码导师扩展，使其包含一个聊天参与者，这将允许用户通过 GitHub Copilot 聊天界面与你的扩展直接交互。你还可以探索 VS Code 中的全系列 API，以探索在编辑器中构建自定义 AI 体验的新方法。
你可以在 vscode-extensions-sample 仓库中找到本教程的完整源代码。