使用 Gemini Code Assist 进行编码

本文档介绍了如何使用 Gemini Code Assist(Google Cloud 中由 AI 赋能的协作工具)在 Cloud Code 中执行以下操作:

  • 提供指导来帮助您解决代码问题。

  • 为您的项目生成代码。

  • 在编码时接收内嵌建议。

Gemini 不会将您的提示或其回答用作数据来训练其模型。如需了解详情,请参阅 Gemini for Google Cloud 如何使用您的数据

为帮助您遵循代码的任何许可要求,当 Gemini Code Assist 的建议直接引用特定来源的详细内容时,它会提供来源引用。要详细了解 Gemini 引用来源的方式和时机,请参阅 Gemini 如何帮助您生成代码和引用来源

本文档面向所有技能水平的开发者。本文档假定您具备 VS Code 的应用知识并熟悉 Google Cloud。如果您愿意,还可以在 Cloud WorkstationsCloud Code for IntelliJCloud Shell Editor 中探索 Gemini Code Assist。

准备工作

  1. 安装 Cloud Code 扩展程序(如果尚未安装)。Cloud Code 可与 IDE 中的 Gemini Code Assist 集成。
  2. 可选:如果您选择克隆本文档中的任务的示例,请安装 Git。 将示例复制到您的计算机需要使用 Git。

连接到 Google Cloud 并选择项目

在本部分中,您将连接到 Google Cloud,并选择已在 IDE 中启用 Cloud AI Companion API 的 Google Cloud 项目。

如果您选择的 Google Cloud 项目未启用 Cloud AI Companion API,您会收到错误通知,并指示其与您的管理员联系。如需了解详情,请参阅为项目设置 Gemini Code Assist

如果您希望直接在 IDE 中按照 Code with Gemini Code Assist 演示指南执行操作,请点击 Launch VS Code(启动 VS Code),然后按照演示中的步骤连接到 Google Cloud 并激活 Genmini Code Assist。

启动 VS Code

否则,请按照以下步骤操作:

  1. 启动您的 IDE。

  2. 在状态栏中,点击 Cloud Code - 登录

    Cloud Code - 状态栏中的登录按钮。

  3. 当系统提示您允许 Cloud Code 打开外部网站时,点击打开

  4. 按照提示登录您的 Google 帐号。

  5. 当系统询问您是否从 Google 下载 Cloud Code 时,点击登录

    您现在已连接到 Google Cloud。

接下来,如需选择已启用 Cloud AI Companion API 的 Google Cloud 项目,请按以下步骤操作:

  1. Gemini Code Assist 状态栏中,点击 Gemini Code Assist

    Gemini 状态栏可用。

  2. Gemini Code Assist 菜单中,选择 选择 Gemini Code Assist 项目

  3. 选择一个已启用 Cloud AI Companion API 的 Google Cloud 项目。

    Gemini 已准备就绪。

    状态栏中的 Gemini 图标已设置为正常。

要测试 Gemini Code Assist 的功能,请打开应用或在下一部分中创建示例应用。

可选:创建示例应用

如果您希望使用现有应用来测试 Gemini Code Assist 的功能,则可以跳过本部分。否则,如需创建示例应用,请按以下步骤操作:

  1. 在 IDE 中,打开命令面板:按 Ctrl+Shift+P(适用于 Windows 和 Linux)或 Command+Shift+P(适用于 macOS),然后运行 Cloud Code: New Application

  2. 选择 Kubernetes 应用

  3. 选择 Python (Flask): Guestbook 应用模板。

  4. 将新应用保存在您偏好的位置。

    系统会显示一条通知来确认您的应用已创建,并会打开一个新窗口,并加载该应用。

与 Gemini Code Assist Chat

在本部分中,您将学习如何打开 Gemini Code Assist 窗格并与 Genmini Code Assist 聊天以获取现有代码的说明。

要开始与 Gemini 聊天,请按以下步骤操作:

  1. 创建新的代码文件或使用现有的代码文件。如果您使用的是 Python (Flask) 示例,则可以在 front.py 文件中执行此任务:依次点击探索器 > src > frontend,然后打开 front.py 文件。

  2. 在 IDE 的活动栏中,点击 chat_spark Gemini Code Assist

  3. Gemini Code Assist 窗格中,输入提示 Explain this code to me,然后点击 send Send

    Gemini 使用代码文件中的代码作为对提示的引用,并在回复中提供代码说明。

    如需引用特定代码块(而不是文件中的所有代码),您可以在代码文件中选择相应代码块,然后提示 Gemini。

重置聊天记录

Gemini Code Assist 会在回答您的提示时使用聊天记录提供更多背景信息。

如果您的聊天记录与您要实现的目标不再相关,您可以重置聊天记录:在 Gemini Code Assist 窗格中,点击 delete Reset Chat

根据提示生成代码

以下各部分介绍了如何使用 Gemini Code Assist 通过 Python 文件中的示例提示 # Function to create a Cloud Storage bucket 生成代码。您还可以选择一段代码,然后通过聊天功能提示 Gemini Code Assist 寻求帮助,以及在编码时接收和接受或拒绝代码建议。

在代码文件中提示 Gemini Code Assist

  1. 创建新的代码文件或使用现有的代码文件。如果您使用的是 Python (Flask) 示例,则可以在 front.py 文件中执行此操作:导航到探索器 > src > frontend,然后打开 front.py 文件。

  2. 在代码文件中另起一行输入 # Function to create a Cloud Storage bucket,然后按 Enter(适用于 Windows 和 Linux)或 Return(适用于 macOS)。

  3. 如需生成代码,请按 Ctrl+Enter(适用于 Windows 和 Linux)或 Ctrl+Return(适用于 macOS)。

    在 Python 文件中的提示文本旁边,Gemini Code Assist 会以幽灵文本的形式生成代码。

  4. 可选:若要接受生成的代码,请按 Tab

可选:更改用于生成代码的键盘快捷键

如果用于生成代码的默认键盘快捷键无法正常工作(如上一部分中所述),您可以按照以下步骤更改键盘快捷键:

  1. 在 IDE 中,点击 File(适用于 Windows 和 Linux)或 Code(适用于 macOS),然后依次转到 Settings > Keyboard Shortcuts

  2. 在键盘快捷键列表中,滚动屏幕,直到您找到 Cloud Code: Generate code

  3. 点击 Cloud Code: Generate Code(Cloud Code:生成代码),然后点击 edit 更改按键绑定

  4. 在显示的对话框中,输入您自己的快捷键。

  5. Enter(适用于 Windows 和 Linux)或 Return(适用于 macOS)。

    您现在可以使用新分配的键盘快捷键,通过 Gemini Code Assist 生成代码。

如需详细了解如何在 IDE 中更改快捷键,请参阅 Visual Studio Code 的按键绑定

通过聊天功能提示 Gemini Code Assist 提供所选代码

Gemini Code Assist 可以根据您选择的代码执行任务或解答您的问题。如需根据包含所选代码的提示生成代码,请按以下步骤操作:

  1. 在 IDE 中,打开包含代码的项目文件,或使用您在前面的步骤中所用的代码文件。

  2. 在活动栏中,点击 chat_spark Gemini Code Assist 以打开 Gemini Code Assist 窗格。

  3. 在代码文件中,选择一个代码块。

  4. Gemini Code Assist 窗格文本字段中,输入针对所选代码的提示。

    例如,在代码中选择一个函数并输入提示 Write a unit test for this function

    Gemini 为所选函数编写单元测试。

    Gemini 使用您选择的代码作为参考,并回答您的提示。

在编码时获取内嵌建议

在您编写代码时,Gemini Code Assist 会提供内嵌代码建议,您可以选择接受或忽略。如需试用此功能,请按以下步骤操作:

  1. 创建新的代码文件或使用现有的代码文件。如果您使用的是 Python (Flask) 示例,则可以在 front.py 文件中执行此操作:导航到探索器 > src > frontend,然后打开 front.py 文件。

  2. 在代码文件中,另起一行开始编写函数。例如,如果您位于 Python 文件中,则写入 def

    Gemini 以幽灵文本的形式建议代码。

  3. 若要接受 Gemini Code Assist 提供的代码建议,请按 Tab。否则,如需忽略建议,请按 Esc 键或继续编写代码。

可选:停用内嵌建议

如果您希望在 Gemini Code Assist 中停用内嵌建议,请按以下步骤操作:

  1. 在 IDE 中,选择 Code(适用于 macOS)或 File(适用于 Windows 和 Linux),然后依次转到 Settings > Settings

  2. 设置对话框的用户标签页上,依次前往扩展程序 > Cloud Code

  3. 滚动屏幕,直到您找到 Cloudcode: Gemini Code Assist: InlineSuggestion: Enable Auto 列表,然后选择关闭

    此操作会关闭内嵌建议。您仍然可以按 Ctrl+Enter(适用于 Windows 和 Linux)或 Ctrl+Return(适用于 macOS)手动触发内嵌建议。

停用与引用的来源匹配的代码建议

如果 Gemini 直接引用其他来源(例如现有的开源代码)中大量内容,则提供引用信息。如需了解详情,请参阅 Gemini 引用信息来源的方式和时间

为防止系统建议与引用的来源匹配的代码,您可以在 settings.json 文件中将 cloudcode.duetAI.recitation.maxCitedLength 设置修改为 0

"cloudcode.duetAI.recitation.maxCitedLength": 0

使用智能操作

为帮助您在最大程度减少上下文切换的同时提高效率,Gemini Code Assist 直接在代码编辑器中提供依托 AI 技术的智能操作。在代码编辑器中选择代码时,您可以查看与您的上下文相关的操作列表,并从中进行选择。

如需在代码中使用智能操作,请按以下步骤操作:

  1. 在代码文件中,选择一个代码块。

  2. 在所选代码块旁边,点击 lightbulb Show Code Actions

    在 VS Code 中选择代码块后,系统会显示智能操作灯泡图标。

  3. 选择一项操作,例如 Generate unit tests

    Gemini 会根据您选择的操作生成回答。

测试其他提示示例

仔细阅读本文档的使用提示生成代码部分后,请尝试执行以下一些示例提示。

获取代码说明

  1. 在代码文件中,选择要说明的函数。
  2. Gemini Code Assist 窗格中,输入提示 Explain this code to me

    Gemini 使用您选择的代码作为参考,并在回复中说明所选函数。

生成测试计划

  1. 在代码文件中,选择要为其添加单元测试的代码。
  2. Gemini Code Assist 窗格中,输入提示 Write unit tests for my code

获取调试代码方面的帮助

  1. 在代码文件中,选择要调试的代码。
  2. Gemini Code Assist 窗格中,输入提示 Help me debug my code

提高代码的可读性

  1. 在代码文件中,选择您希望用户更容易读懂的代码。
  2. Gemini Code Assist 窗格中,输入提示 Make my code more readable

    如果您希望专注于代码的特定部分,请在提示 Gemini 之前选择首选代码部分。

已知问题

以下部分概述了 Gemini Code Assist 的已知问题。

如果 Chat 响应包含大型打开文件的更新版本,则可能会被截断

如需解决此问题,请选择一小段代码,并在聊天提示中添加一条额外的指令,例如 only output the selected code.

Vim:除非在插入模式下,否则无法接受或关闭代码生成建议

在普通模式下使用 Vim 插件时,您无法接受或关闭代码建议。

若要解决此问题,请按 i 进入插入模式,然后按 Tab 接受建议。

Vim:按 Esc 关闭建议时行为不一致

当您按 Esc 键时,IntelliJ 和 Gemini 建议都会被关闭。此行为与非 Vim 行为不同,在非 Vim 行为中,按 Esc 会重新触发 Gemini。

许可重复警告在会话间不保留

如果许可复制警告在会话中不持续存在,请参阅持久性日志:

  1. 依次点击查看 > 输出

  2. 选择 Gemini Code Assist - Citations

Gemini Code Assist 输出窗口中的连接问题

如果您在 Gemini Code Assist 输出窗口中看到连接错误或其他连接问题,请尝试以下操作:

  • 将防火墙配置为允许访问 oauth2.googleapis.comcloudaicompanion.googleapis.com

  • 将您的防火墙配置为允许通过 gRPC 使用的 HTTP/2 通信。

您可以使用 grpc-health-probe 工具测试连接性。如果检查成功,会生成以下输出:

$ grpc-health-probe -addr cloudaicompanion.googleapis.com:443 -tls error: this server does not implement the grpc health protocol (grpc.health.v1.Health): GRPC target method can't be resolved

如果检查失败,则会显示以下输出:

timeout: failed to connect service "cloudaicompanion.googleapis.com:443" within 1s

如需了解详情,请在 grpc-health-probe 之前运行以下命令:

export GRPC_GO_LOG_SEVERITY_LEVEL=info

提供反馈

要提供您的体验反馈,请按以下步骤操作:

  1. 在状态栏中,点击 Gemini Code Assist,然后在快速选择菜单中选择发送反馈

  2. 在表单中填写 TitleComments 字段。

  3. 如果要共享 Skaffold 或 AI Companion 日志,请务必选择发送 Skaffold 日志发送 AI Companion 日志选项。

  4. 点击提交反馈

后续步骤