教程：使用语言模型 API 生成由 AI 驱动的代码注释
在本教程中，您将学习如何创建 VS Code 扩展以构建一个由 AI 驱动的代码辅导员。您将使用语言模型 (LM) API 生成改进代码的建议，并利用 VS Code 扩展 API 将其无缝集成到编辑器中，作为用户可以悬停查看更多信息的内联注释。完成本教程后，您将知道如何在 VS Code 中实现自定义 AI 功能。
前提条件
完成本教程，您需要以下工具和帐户
搭建扩展框架
首先，使用 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"
}
]
}
由于我们要构建一个 Code Tutor 扩展，它将向行添加注释，因此我们需要一个命令，允许用户切换这些注释的开/关。更新 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”命令
为了使我们的 Code Tutor 注释工作，我们需要向它发送一些代码并要求它提供注释。我们将分三步进行
- 从用户当前打开的标签页中获取包含行号的代码。
- 将该代码连同一个自定义提示一起发送到语言模型 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;
}
此代码使用 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);
}
);
步骤 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'
});
}
);
我们需要指令 - 或者说一个“提示” - 来告诉模型创建注释，以及我们希望响应的格式是什么。在文件顶部，紧邻 imports 下方添加以下代码。
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 将这些称为“装饰”。在 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"
}
]
}
}
这会在编辑器标题栏的导航区域（右侧）显示一个按钮。“icon”来自 产品图标参考。
使用绿色箭头重启您的扩展，如果扩展尚未运行，则按 F5。现在您应该看到一个评论图标，它将触发“Toggle Tutor Annotations”命令。
后续步骤
在本教程中，您学习了如何创建一个 VS Code 扩展，该扩展使用语言模型 API 将 AI 集成到编辑器中。您使用了 VS Code 扩展 API 从当前标签页获取代码，使用自定义提示将其发送到模型，然后使用装饰器在编辑器中解析并显示模型结果。
接下来，您可以扩展您的 Code Tutor 扩展，以 包含一个聊天参与者，这将允许用户通过 GitHub Copilot 聊天界面直接与您的扩展进行交互。您还可以 探索 VS Code 中的全部 API 范围，以探索在编辑器中构建自定义 AI 体验的新方式。
您可以在 vscode-extensions-sample 仓库中找到本教程的完整源代码。