本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
与 Amazon Q 开发者一起开发功能
Amazon Q Developer 可以帮助您在集成开发环境 (IDE) 中开发代码功能或对项目进行代码更改。您解释要完成的任务,Amazon Q 则使用您当前项目或工作区的上下文信息来生成代码,从而实施更改。Amazon Q 可以帮助您构建 AWS 项目或您自己的应用程序。
您可以在 IDE 中启动一个全新的项目,也可以处理一个打开的项目。您在现有项目中进行开发时,Amazon Q 会使用工作区根目录中的所有相关文件作为上下文来生成代码。Amazon Q 会筛选出 .gitignore
文件中定义的文件或文件夹,并且仅使用支持的文件类型生成代码。有关支持的文件类型的列表,请参阅您的 IDE 的以下 GitHub 链接:
-
支持的文件类型 JetBrains IDEs – http://github.com/aws/aws-toolkit-jetbrains/blob/main/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/services/telemetry/TelemetryUtils.kt
-
支持的文件类型 Visual Studio Code – http://github.com/aws/aws-toolkit-vscode/blob/master/packages/core/src/shared/filetypes.ts
要开始使用,请打开一个新项目或现有项目,然后在 Amazon Q 聊天面板中输入 /dev
。将打开一个新的聊天选项卡,您可以在其中与 Amazon Q 互动,为您的功能生成新代码。
使用 /dev
开发功能
要在 IDE 中使用 Amazon Q 处理代码任务,请完成以下步骤。
-
在 IDE 中,打开要在其中开发功能的新项目或现有项目或工作区。
-
选择 Amazon Q 图标以打开 Amazon Q 聊天面板。
-
在 Amazon Q 聊天面板中输入
/dev
,然后输入您要完成的任务或要解决的问题的描述。您可以提供任务的简要概述,也可以添加更多详细信息。Amazon Q 使用您的描述和项目中的代码来生成代码。以下是您可以让 Amazon Q 实施的代码更改示例:
/dev Create a new REST API endpoint /api/authenticate to handle user authentication. This endpoint should accept POST requests with user credentials and return a JWT token upon successful authentication. Additionally, update the user management system to integrate with the new authentication endpoint and enforce authentication for relevant API endpoints.
您也可以只输入
/dev
来查看示例任务。 -
将打开一个新选项卡。如果您尚未这样做,请输入任务或问题的描述。
-
Amazon Q 开始为您所描述的任务生成代码。在代码生成过程中,Amazon Q 会提供其正在采取的步骤以及为建议新代码而正在使用或更新的文件的摘要。这一步可能需要几分钟的时间。
如果您希望 Amazon Q 停止生成代码,请选择停止。未完成的代码生成将计入此任务的代码生成配额。停止某一代后,您可以选择输入其他任务描述以继续处理您的任务。
或者,Amazon Q 可以在单独的开发环境中测试其代码建议,然后再在聊天窗口中向您呈现。有关更多信息,请参阅 正在测试 “/dev” 建议。
-
在 Amazon Q 为您的任务生成代码后,它会提供包含建议更改的文件列表。选择一个文件以查看包含更改的文件差异。
-
要使用所有建议的代码更改更新您的文件,请选择接受所有更改。您也可以接受和拒绝对单个文件所做的更改。要接受单个文件更改,请将光标悬停在文件名上,然后选择绿色复选标记。要拒绝更改,请选择红色 X。您也可以选择 “接受剩余的更改” 以应用您尚未接受的任何更改。
一旦您接受了代码更改,就无法撤消更改。如果您拒绝代码更改,则可以通过将鼠标悬停在文件名上并选择箭头来恢复更改。然后,您可以选择再次接受或拒绝代码更改。
-
如果您对建议更改不满意,可以就可以改进的地方提供反馈。选择 “提供反馈并重新生成”,然后描述您希望 Amazon Q 做出的更改。
Amazon Q 会根据您的反馈生成新代码。当生成的代码满足您的要求时,选择接受所有更改或接受单个文件以更新项目或工作区中的代码。
-
更新代码后,Amazon Q 会提示您开始执行新任务。
要开始处理项目或工作区中的其他任务,请选择是, 我还有其他任务。您之前的对话和生成的代码不会用作新任务的上下文。
要结束功能开发会话,请选择否,谢谢。要继续与 Amazon Q 聊天或启动其他工作流,请打开新的聊天选项卡。
最佳实践
要充分利用 Amazon Q 进行功能开发,请遵循以下最佳实践:
-
详细描述您要开发的新功能或要实施的代码更改,包括代码应达到的规格。这样,Amazon Q 就可以提出全面且可实施的代码更改建议。有关示例,请参阅 示例任务。
-
您的功能不应要求一次更新超过 5 个文件。要求 Amazon Q 进行更大规模的更改可能会影响您的功能实施的质量和可管理性。如果您的文件差异包括对许多文件的更改,请尝试缩小功能描述的范围。
示例任务
以下是您可以让 Amazon Q 执行的功能开发任务示例,以及您可能提供的相应描述。
-
更新 CSS 样式以提高布局响应能力:通过更新 CSS 样式来增强应用程序布局的响应能力。重点调整不同屏幕尺寸的布局,确保在各种设备上实现最佳显示效果。
-
修复用户个人资料图片上传:解决妨碍用户上传个人资料图片的问题。调查文件上传过程,确保正确验证文件类型,并解决任何阻碍成功上传的服务器端错误。
-
重构代码以提高代码的可读性:通过重构特定代码模块来提高其可读性。将复杂的函数分解为更小、更易于管理的单元,并应用有意义的变量和函数名称以提高清晰度。
-
为联系表单实现输入验证:向联系表单添加客户端和服务器端输入验证,以防止提交空表单或无效数据。如果验证失败,则向用户显示相应的错误消息。
-
修复导航菜单中损坏的链接:调查并修复应用程序导航菜单中损坏的链接。更新 URLs 或路线,确保所有导航链接都指向正确的页面。
-
优化图像加载以加快页面加载速度:优化应用程序关键页面上的图像加载以减少页面加载时间。实现惰性加载或异步加载技术,以优先显示可见内容。
-
为关键 API 端点添加错误日志记录:通过为关键 API 端点实施日志记录来增强错误处理能力。记录相关的错误详细信息,例如请求参数和堆栈跟踪,以便于调试和故障排除。
-
更新 API 端点的文档:查看并更新现有 API 端点的文档,以反映最近的更改或新增内容。为使用 API 的开发者确保信息的准确性和完整性。
-
重构数据库查询以提高效率:分析和优化数据库查询以提高效率并减少资源消耗。识别并消除冗余查询,优化索引,并在适用的情况下考虑缓存策略。
限额
Amazon Q 的功能开发保持以下配额:
-
每个任务的代码生成-您可以提供反馈以为给定开发任务(包括初始代码生成)重新生成代码的次数。每次启动新任务时,都会重置此配额。
-
代码项目大小-Amazon Q 可用作上下文生成新代码的代码文件或文件夹的最大大小。
资源 | 限额 |
---|---|
每个任务的生成代码次数 | 10 |
代码项目大小 | 200 MB(未压缩) 50 KB(压缩) |