使用 Gemini Code Assist 编写代码

本文档介绍了如何使用 Gemini Code Assist 是 AI 赋能的一款应用, 可帮助您在 Cloud Shell 中执行以下操作:

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

  • 为您的项目生成代码。

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

了解 Gemini for Google Cloud 如何以及何时使用您的数据

为帮助您遵守代码的所有许可要求,当 Gemini Code Assist 的建议直接引用特定来源的长篇内容时,它会提供来源引用。如需详细了解 Gemini 会注明信息来源的情况和方式,请参阅 Gemini 如何帮助您生成代码并注明信息来源

借助代码自定义功能,您可以直接从 Gemini Code Assist 获取基于贵组织私有代码库的代码建议。了解 如何配置代码自定义

本文档面向各种技能水平的开发者。本文假定您已具备 Cloud Shell 编辑器的实际运用知识,并熟悉 Google Cloud。如果您愿意,还可以探索 Gemini Code Assist: Cloud WorkstationsCloud Code for IntelliJ适用于 VS Code 的 Cloud Code

连接到 Google Cloud 并选择项目

在本部分中,您将连接到 Google Cloud,并在 Cloud Shell 编辑器中选择已启用 Gemini for Google Cloud API 的 Google Cloud 项目。

如果您选择的 Google Cloud 项目未启用 Gemini for Google Cloud API,您会收到一条通知,其中包含从 IDE 启用该 API 的选项。在通知窗口中选择 Enable the API(启用 API),为您的项目启用该 API。如需了解详情,请参阅为项目设置 Gemini Code Assist

如需在 Cloud Shell Editor 中连接到 Google Cloud,请按以下步骤操作:

  1. 启动 Cloud Shell Editor

  2. 如果您使用的是旧版编辑器,请点击试用新编辑器

  3. 在状态栏中,点击 Cloud Code - Sign In(Cloud Code - 登录)。

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

  4. 如果系统提示您授权 Cloud Shell Editor 进行 Google Cloud API 调用,请点击授权

  5. 按照提示登录您的 Google 账号。

    您现已连接到 Google Cloud。

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

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

    Gemini 状态栏显示可用。

  2. Gemini Code Assist 菜单中,选择 Select Gemini Code project(选择 Gemini Code 项目)。

  3. 选择已启用 Gemini for Google Cloud API 的 Google Cloud 项目。

    可以开始使用 Gemini 了。

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

与 Gemini Code Assist 聊天

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

如要开始与 Gemini 对话,请按以下步骤操作:

  1. 打开您的代码文件。

  2. 在 Cloud Shell Editor 的活动栏中, 点击 spark Gemini Code Assist

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

    Gemini 使用代码文件中的代码作为对 并在响应中提供代码的解释

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

重置聊天记录

Gemini Code Assist 会根据聊天记录提供更多背景信息 。

如果您的聊天记录不再与您想达到的目的有关, 可以重置聊天记录:在 Gemini Code Assist 窗格中,点击 delete 重置聊天

根据提示生成代码

以下部分将介绍如何使用 Gemini Code Assist 在代码文件中使用示例提示 Function to create a Cloud Storage bucket 生成代码。你还可以选择代码的一部分 通过聊天功能提示 Gemini Code Assist 获取帮助;以及 在您编码时接收、接受或拒绝代码建议。

在代码文件中提示 Gemini Code Assist

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

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

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

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

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

如果用于生成代码的默认键盘快捷键不起作用 您可以更改键盘快捷键 步骤:

  1. 在 Cloud Shell 编辑器中 点击 menu 菜单,然后转到 文件 > 偏好设置 > 键盘快捷键

  2. 在键盘快捷键列表中,搜索 Cloud Code: Generate Code

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

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

  5. Enter(适用于 Windows 和 Linux)或回车键(适用于 macOS)。

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

通过聊天使用所选代码向 Gemini Code Assist 发出提示

Gemini Code Assist 可以执行任务或回答您的问题 指定代码。为了获得基于 提示,请按以下步骤操作:

  1. 在活动栏中,点击 spark Gemini Code Assist 打开 Gemini Code Assist 窗格。

  2. 在您的代码文件中,选择一个代码块。

  3. Gemini Code Assist 窗格文本字段中,输入关于 所选代码。

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

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

    Gemini 会使用您选择的代码作为参考,并根据您的问题做出回答。

在编码时获取内嵌建议

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

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

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

  2. 若要接受 Gemini Code Assist 给出的代码建议,请按 Tab 键。否则,若要忽略建议,请按 Esc 或 继续编写代码。

可选:停用内嵌建议

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

  1. 在 Cloud Shell 编辑器中 选择 menu 菜单,然后转到文件 > 偏好设置 > 设置

  2. 设置对话框的用户标签页上,转到扩展程序 > Cloud Code

  3. 滚动屏幕,直至找到 Cloudcode: Gemini Code Assist: InlineSuggestion: Enable(Cloudcode:Gemini Code Assist:内嵌建议:启用) 自动列表,然后选择关闭

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

可选:使用 .aiExclude 文件从上下文中排除文件

你可以将某些文件排除在 Gemini Code Assist 考虑范围之外 通过创建 .aiexclude 文件来获取上下文。.aiexclude 文件遵循 与 .gitignore 文件的语法类似,具体区别如下:

  • 空的或不存在的 .aiexclude 文件不会阻止其目录中的文件,并且 所有子目录。
  • .aiexclude 文件不支持否定操作,即在模式前面添加感叹号 (!)。
  • .aiexclude 文件会贪心地匹配 * 字符。这将不加区分地匹配目录和文件。此 .aiexclude 文件不 区分文件夹或文件的 ***

目前仅支持单个 .aiexclude 文件。如需配置 .aiexclude 文件,请在工作区文件夹的根目录中创建一个名为 .aiexclude 的文件。如果您想将此文件放在工作区根目录之外,或重命名该文件,可以在 VS Code 设置中的“上下文排除文件”下设置路径。此设置中提供的路径值将相对于打开的工作区的根文件夹解析。

示例

以下示例演示了如何配置 .aiexclude 文件:

  • 屏蔽工作区目录中或下方的所有名为 apikeys.txt 的文件:

    apikeys.txt
    
  • 屏蔽工作区中或下方所有扩展名为 .key 的文件 目录:

    *.key
    
  • 仅屏蔽 .aiexclude 文件所在目录中的 apikeys.txtfile。 但不包含任何子目录:

    /apikeys.txt
    
  • 屏蔽 my/sensitive/dir 目录及其所有子目录中的所有文件。路径应相对于工作区根目录。

    my/sensitive/dir/*
    

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

当 Gemini 直接引用以下资源时,它会提供引用信息 长度。有关 请参阅 Gemini 会注明信息来源的情况和方式

要防止系统建议与引用的来源匹配的代码,您可以修改 在cloudcode.duetAI.recitation.maxCitedLength0 settings.json 文件:

"cloudcode.duetAI.recitation.maxCitedLength": 0

使用智能操作

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

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

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

  2. 在所选代码块旁边,点击 lightbulbShow Code Actions(显示代码操作)。

    在 Shell 和 Workstations 中选择代码块后,显示智能操作灯泡图标。

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

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

使用代码转换

Gemini Code Assist 提供代码转换,可让您 可以选择代码文件的部分内容, 使用内嵌文本框,根据自然语言的提示来生成现有代码。

借助代码转换,您可以执行以下操作:

  • 生成注释行以记录代码
  • 对代码进行问题排查
  • 提高代码可读性
  • 让代码更加高效

你还可以在 Gemini:Chat 窗格中查看生成的回答的上下文来源。

使用内嵌文本框向 Gemini Code Assist 发出提示

通过内联文本框,您可以与 Gemini Code Assist 中。

如需打开内嵌文本框并提示 Gemini,请按以下步骤操作 步骤:

  1. 在代码文件中,按 Control+I(适用于 Windows 和 Linux)或 Command+I(适用于 macOS)。

  2. 输入提示,例如“Write a function to create a Cloud Storage bucket”和 按 Enter 键(适用于 Windows 和 Linux)或 Return 键(适用于 macOS)。

    Gemini Code Assist 会根据您的提示生成代码。

查看重构后的代码的差异

将差异视图内置于内嵌文本框中,您可以看到 Gemini 提供的建议和您的原始代码。然后,您可以接受或 并舍弃建议的更改

如需通过内嵌文本框查看重构后的代码的差异,请执行以下步骤:

  1. 在代码文件中,选择一个函数,然后按 Control+I(适用于 Windows 和 Linux)或 Command+I(适用于 macOS)打开内嵌文本框。

  2. 输入提示符(例如 Add comments),然后按 Enter(适用于 Windows 和 Linux)或 Return(适用于 macOS)。

    当 Gemini 为所选函数生成代码更改时,系统会显示差异视图。

    Gemini:Chat 窗格中列出的上下文来源。

  3. 要接受或舍弃更改,请点击接受舍弃

查看所生成回答的上下文来源

上下文显示功能会列出用作参考来生成对你问题的回答的项目文件(上下文来源)。了解 文件用作参考,有助于你优化提示并获得更多 特定响应。您每次使用时都会显示上下文来源 Gemini 对话。

如需查看所生成回答的背景信息来源,请在 Gemini:Chat 中 窗格,滚动直至看到上下文来源代码段。展开代码段 查看所有上下文源。

Gemini:Chat 窗格中列出的上下文来源。

使用智能命令

智能命令是指可在内嵌文本框中用于执行各种操作的命令, 代码的特定操作

如需使用 /explain 智能命令获取整个代码文件的说明,请按以下步骤操作:

  1. 在代码文件中,按 Control+I(适用于 Windows 和 Linux)或 Command+I(适用于 macOS)打开内嵌文本框。

  2. / 查看智能命令列表及其说明。

  3. 选择 /explain

    Gemini 会在 。

  4. 可选:如果你想在 Gemini:对话窗格中查看生成的回答,请点击在对话中查看

查看提示历史记录

当您需要在大型代码文件中输入相同的提示时,访问提示历史记录可节省时间。

如需访问提示历史记录,请在代码文件中按 Control+I(适用于 Windows 和 Linux)或 Command+I(适用于 macOS)打开内嵌文本框,然后按 Control+向上键(适用于 Windows 和 Linux)或 Command+向上键(适用于 macOS)。这样你就可以循环检查 旧提示,并在需要时重复使用。

提高了非英语母语人士的代码可读性

如果您不是以英语为母语,而是使用翻译应用,则可以使用内嵌文本框以其他语言生成评论。

将英文评论翻译成其他语言或添加其他语言的新评论 请按以下步骤操作:

  1. 在您的代码文件中,选择要添加注释的代码。

  2. Ctrl+I(适用于 Windows 和 Linux)或 Command+I(对于 macOS)。

  3. 输入提示,例如 Add spanish comments,然后按 Enter 键( Windows 和 Linux)或 Return 键(适用于 macOS)。

    Gemini 会以你指定的语言生成评论 并查看这些建议的差异。

  4. 要接受或舍弃对代码所做的更改,请点击接受舍弃

测试其他示例提示

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

获取代码说明

  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 的已知问题。

许可复制警告在会话间不持续显示

如果许可朗读警告不会在会话之间保留,请参阅永久性日志:

  1. 依次点击 menu 菜单 > 视图 > 输出

  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

选择 Gemini Code Assist 项目后,系统仍会显示“激活 Gemini Code Assist”

如果您按照此部分中的说明选择了您的项目, 指南,包括启用适用于 Google Cloud API 的 Gemini,则 LS 服务器出现问题。

如需详细了解您的问题,请执行以下操作:

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

  2. 点击任意日志文件的显示,即可查看更多详细信息,以便排查问题。

提供反馈

如需就您的体验留下反馈,请按以下步骤操作:

  1. 在状态栏中,点击 Gemini Code Assist,然后在 Quick Pick 菜单中,选择 Send feedback

  2. 在表单中填写标题评论字段。

  3. 如果您想分享 Skaffold 或 AI 配套工具日志,请务必选择发送 Skaffold 日志发送 AI 配套工具日志选项。

  4. 点击提交反馈

后续步骤