使用 GitHub Copilot 的最佳实践

了解 Copilot 的优势和劣势

GitHub Copilot 是一款 AI 编码助手，可帮助您更快、更轻松地编写代码，让您能够将更多精力集中在解决问题和协作上。在开始使用 Copilot 之前，了解何时应该以及何时不应该使用它非常重要。

Copilot 最擅长的任务包括：:

• 编写测试和重复代码
• 调试和纠正语法
• 解释和注释代码
• 生成正则表达式

Copilot 并非设计用于：:

• 回复与编码和技术无关的提示
• 取代您的专业知识和技能。请记住，您是负责人，Copilot 是为您服务的强大工具。

选择合适的 Copilot 工具

虽然 Copilot 代码补全和 Copilot 聊天共享一些功能，但这两个工具最适合在不同的情况下使用。

代码补全最适合：:

• 在您编写代码时补全代码片段、变量名和函数
• 生成重复代码
• 从自然语言的内联注释中生成代码
• 为测试驱动开发生成测试

另一方面，Copilot 聊天最适合：:

• 使用自然语言回答有关代码的问题
• 生成较大的代码段，然后迭代该代码以满足您的需求
• 使用关键词和技能完成特定任务。Copilot 聊天内置了旨在为提示提供重要上下文并快速完成常见任务的关键词和技能。不同类型的关键词和技能在不同的 Copilot 聊天平台上可用。请参阅“在您的 IDE 中向 GitHub Copilot 提问”。
• 以特定角色完成任务。例如，您可以告诉 Copilot 聊天它是一位非常重视代码质量、可读性和效率的高级 C++ 开发人员，然后请它审查您的代码。

创建有意义的提示

提示工程，或者构建您的请求以便 Copilot 能够轻松理解和响应它，在 Copilot 生成有价值的响应的能力中起着至关重要的作用。以下是一些在撰写提示时应记住的快速技巧：

• 分解复杂的任务。
• 明确您的需求。
• 提供输入数据、输出和实现等示例。
• 遵循良好的编码实践。

要了解更多信息，请参阅“GitHub Copilot 的提示工程”。

检查 Copilot 的工作

虽然 Copilot 非常强大，但它仍然是一个可能出错的工具，您应该始终验证它建议的代码。使用以下技巧来确保您接受的是准确、安全的建议：

• 在实施建议的代码之前先理解它。为了确保您完全理解 Copilot 的建议，您可以请 Copilot 聊天解释该代码。
• 仔细审查 Copilot 的建议。不仅要考虑建议代码的功能和安全性，还要考虑代码的未来可读性和可维护性。
• 使用自动化测试和工具来检查 Copilot 的工作。借助 linting、代码扫描和 IP 扫描等工具，您可以自动化额外的安全性和准确性检查。

引导 Copilot 生成有用的输出

您可以进行一些调整，以引导 Copilot 生成更有价值的响应：

• 为 Copilot 提供有用的上下文:
  • 如果您在 IDE 中使用 Copilot，请打开相关文件并关闭不相关文件。
  • 在 Copilot 聊天中，如果某个特定请求不再是有用的上下文，请从对话中删除该请求。或者，如果对话的任何上下文都没有帮助，请开始新的对话。
  • 如果您在 GitHub 中使用 Copilot 聊天，请提供特定的存储库、文件、符号等作为上下文。请参阅“在 GitHub 中向 GitHub Copilot 提问”。
  • 如果您在 IDE 中使用 Copilot 聊天，请使用关键词将 Copilot 的注意力集中在特定任务或上下文上。请参阅“在您的 IDE 中向 GitHub Copilot 提问”。
• 重写您的提示以生成不同的响应。如果 Copilot 没有提供有用的响应，请尝试改写您的提示，甚至将您的请求分解成多个较小的提示。
• 选择最佳的可用建议。当您使用代码补全时，Copilot 可能会提供多个建议。您可以使用键盘快捷键快速查看所有可用建议。有关您的操作系统的默认键盘快捷键，请参阅“在您的环境中配置 GitHub Copilot”。
• 提供反馈以改进未来的建议。您可以通过多种方式提供反馈：
  • 对于代码补全，接受或拒绝 Copilot 的建议。
  • 对于 Copilot 聊天中的单个回复，点击回复旁边的点赞或点踩图标。
  • 对于 IDE 中的 Copilot 聊天，请参阅“在您的 IDE 中向 GitHub Copilot 提问”，了解特定于您环境的说明。
  • 对于 GitHub 中的 Copilot 聊天，请在 反馈讨论 中发表评论。

及时了解 Copilot 的功能

Copilot 定期添加新功能，以创建新功能、构建现有功能并改善用户体验。要及时了解 Copilot 的功能，请参阅 变更日志。