Claude 3.5 十四行诗：用 GitHub Copilot 寻找解决方案

DALL-E 3[^1^]\

[^1^]: DALL-E 3 是一个生成图像的 AI 模型。

4个问题及更多回答：

灵感文章：链接：https://medium.com/data-science-at-microsoft/from-internet-to-ai-my-experience-with-github-copilot-9ac60fc268e0。这是我从互联网到人工智能的经验，以及使用 GitHub Copilot 的体验。

下面是你列出的与GitHub Copilot一起工作的简要步骤：

1. 理解项目：通过 Copilot 来更好地理解现有的代码库和项目结构。
2. 寻找解决方案：利用 Copilot 的建议来编写代码和解决问题。
3. 获取即时答案：利用 Copilot 快速获取代码建议，但始终要验证其输出的准确性和适当性。
4. 测试和故障排除：利用 Copilot 来帮助编写测试用例以及调试代码。

以下步骤描述了在软件开发中有效利用GitHub Copilot的流程。

克劳德3.5的十四行诗：

让我们进一步说明每个步骤，以更全面地理解如何在您在开发中的工作流程中有效地利用GitHub Copilot：

1. 使用 GitHub Copilot 来了解项目：

• 让 Copilot 分析现有代码并解释
• 让 Copilot 总结函数、类或整个文件
• 利用 Copilot 了解项目中的编码风格和规范
• 让 Copilot 为遗留代码提供建议以进行现代化改造

2. 使用 GitHub Copilot 寻找解决方案

• 让 Copilot 帮你生成样板代码和常见的编程模式
• 向 Copilot 询问如何实现特定算法或功能
• 利用 Copilot 探索解决某个问题的不同方法
• 从 Copilot 的建议开始，然后根据需要调整和优化代码

3. 立即得到答案，不过要再次核实一下

• 使用 Copilot 生成快速的代码片段和功能实现
• 始终检查 Copilot 的建议以确保其正确性和安全性
• 验证 Copilot 生成的代码段是否符合项目风格指南和最佳实践
• 将 Copilot 的建议用作学习工具，帮助理解新的概念或技术

4. 更轻松的测试和排障：

• 让Copilot帮助你生成函数的单元测试
• 让Copilot帮你找出潜在的边界情况来进行测试
• 在调试时让Copilot帮你解释错误信息或提供修复建议
• 利用Copilot将代码重构得更易于测试

额外考虑的事项

• 将 Copilot 集成到您现有的开发工具和工作流程中
• 跟紧 Copilot 的功能和能力的最新变化
• 务必理解它生成的代码
• 结合 Copilot 的建议与您自己的专业知识和批判性思考

记得，虽然GitHub Copilot是一个强大的工具，但它旨在提升你的技能，而不是替代它们。在使用由AI生成的代码建议时，始终运用你自己的判断和专业知识。

让我们深入了解一下如何用GitHub Copilot更好地理解项目

1. 使用Copilot来检查和理解现有的代码，并提供相应的解释。

• 当你打开一个文件后，可以开始输入注释，例如“// 解释这个函数:”或“# 这段代码做了什么？”
• Copilot 可以为复杂的算法或陌生的代码模式提供见解
• 用它来理解第三方库或前任同事留下的旧代码
• 比如“// 这个变量的目的是什么？”或“# 这个循环为什么这样结构？”

2. 让Copilot 概括总结函数、类或整个文件的内容：

• 添加注释，例如“// 概述这个类:”或“# 概述这个文件:”
• Copilot 可以提供代码目的和结构的高层次概述
• 利用这一点可以快速理解项目中各个部分的作用
• 对于大型文件，你可以让 Copilot 概述特定部分或函数

3. 使用Copilot来理解项目中的编码模式和惯例。

• 分析多个文件来找出一致的命名规范或设计模式
• 向Copilot提问比如“//这里使用了什么设计模式？”的问题
• 利用Copilot了解项目特定的惯用表达或最佳实践
• 让Copilot给建议在添加新功能时如何保持与现有代码的一致性

4. 让Copilot为旧代码提出改进或现代化的建议。

• 让Copilot建议更新废弃的方法或库
• 在代码中使用这样的注释如“// 如何使这段代码现代化？”或“# 建议性能改进：”
• 让Copilot提供重构建议来让代码更易读和更高效
• 利用Copilot帮助将代码迁移到更新的语言版本或框架

有效使用的小贴士。

• 提问时要具体，这样才能得到更准确和相关的回复。
• 可以将Copilot的建议作为进一步研究或与团队讨论的起点。
• 将Copilot的分析与你的代码审查实践相结合。
• 记住，Copilot的理解是基于训练数据中的模式的，所以要始终验证它的建议。

需要注意的限制条件:

• Copilot 可能在没有额外上下文的情况下无法理解独特或高度专业化的代码
• 它可能无法完全把握代码背后的业务逻辑或需求
• Copilot 的建议基于公开代码，可能无法完全符合你组织的特定标准

通过使用GitHub Copilot，你可以更快地深入了解项目的代码库，找到需要改进的地方，并在代码结构和设计上做出更明智的决定。这在新成员加入或处理大型项目中的陌生部分时尤其有价值。

让我们来看看如何更好地利用GitHub Copilot来解决问题：

1. 使用 Copilot，生成样板代码和常用的编程模式：

• 开始输入一个常见结构的开头，如“class”，“function”，“for loop”，让Copilot提供完成建议
• 使用注释来描述你需要的内容，例如“// 创建一个用于用户注册的REST API端点”
• 要求特定模式，例如“// 用Python实现单例模式”
• 利用Copilot处理重复任务，如创建构造函数、获取器和设置器方法

1. 向Copilot询问关于实现特定算法或功能的一些建议，例如：

• 在注释中描述算法或功能，例如：“// 实现快速排序算法”
• 对于复杂的功能，将其拆分成更小的部分，并就每个部分向Copilot询问。
• 使用Copilot来为现有算法提供优化建议。
• 请求特定语言的实现方式，例如“// 在JavaScript中为API调用实现异步/等待”

3. 利用Copilot（代码助手）来探索解决一个问题的不同方法：

• 在评论中提出你的问题，并让Copilot为你提供多种解决方案
• 让Copilot用不同的编程范式，比如函数式与面向对象，实现相同的功能
• 使用类似于“// 替代方法:”的注释来获取同一问题的不同建议
• 比较Copilot的建议，找出不同实现之间的权衡

4、将 Copilot 的建议作为起点，然后根据需要自定义和优化代码：

• 用 Copilot 生成初始实现，然后根据您的实际需求进行调整
• 向 Copilot 询问关于其建议的解释，以便更好地理解，以更好地理解和定制代码
• 使用 Copilot 来帮助您优化定制的代码，以提升效率或可读性
• 通过要求改进或变化来调整 Copilot 的建议

好的做法：

• 在使用 Copilot 的建议之前，一定要先仔细审查并理解这些提示。
• 把 Copilot 的输出当作灵感来源，而不是直接采纳。
• 将 Copilot 的建议与你的领域知识和实际项目需求相结合。
• 利用 Copilot 来了解你不熟悉的库或语言特性。

考虑如下：

• Copilot 的建议基于公开代码，因此在处理敏感或专有的算法时要格外小心。
• Copilot 建议的质量取决于你提供的提示是否清晰和具体。
• Copilot 有时可能会给出过时或不太合适的解决方案，因此请参照最新的文档来验证。
• 结合使用 Copilot 和其他资源，例如官方文档和社区论坛。

通过有效地使用GitHub Copilot，你可以显著地加快开发进度，探索更多可能的解决方案，并学习新的编码技术。记住，Copilot是一个提高你的工作效率和激发你的创造力的工具，而是为了增强你的专业技能和批判性思维，并非替代它们。

让我们看看在使用GitHub Copilot时获取即时答案，确保这些答案既准确又合适的方法：

1. 使用 Copilot 快速编写函数实现和代码片段。

• 输入函数签名的开头或描述性的注释，让Copilot为你提供实现建议

• 使用Copilot来完成常见任务，例如数据解析、文件读写或API请求

• 请求特定的辅助函数，比如：“// 用于验证电子邮件地址的函数”

• 利用Copilot来了解特定语言的惯用表达或最佳实践

1. 经常检查 Copilot 的建议，确保其正确且安全。

• 仔细阅读每个建议，理解其逻辑并考虑可能的边界情况
• 检查常见的安全问题，如SQL注入、跨站脚本攻击(XSS)或不正确的输入验证
• 确认错误处理和边界情况是否得到了妥善处理
• 在使用自动化安全扫描工具时，参考Copilot的建议
• 在处理涉及身份验证、数据加密或敏感信息的代码时要格外小心

3. 确保 Copilot 的代码遵循你的项目风格指南和最佳实践标准：

• 将 Copilot 的建议与团队的编码标准和风格指南进行对照
• 检查命名约定、缩进和代码组织的一致性，确保遵循团队的风格指南
• 确保建议的代码符合项目的架构模式和设计原则
• 根据项目的具体需求调整 Copilot 的建议
• 使用代码检查工具和代码格式化工具确保代码的一致性

1. 可以参考 Copilot 的建议来学习新概念和技术。

• 当 Copilot 提出你不熟悉的模式或功能时，花时间去研究和了解它们
• 用 Copilot 探索不同的编程范式和语言特性
• 在代码中添加注释“// 解释这段代码：”，然后让 Copilot 解释
• 将 Copilot 的实现与官方文档或教程进行对比，加深你对代码的理解
• 使用 Copilot 来生成你正在学习的库或 API 的示例用法

与 Copilot 即时回复配合的实用技巧

• 养成批判性地评估所有代码的习惯，不论是自己、同事写的，还是Copilot建议的
• 把Copilot的建议当作起点，而不是最终答案
• 定期更新你在领域内最佳实践和安全考量方面的知识
• 结合Copilot建议和同事的代码审查，以增加一层验证
• 记录任何显著偏离Copilot建议的情况及其背后的理由

需要注意的潜在问题有：

• 过度依赖Copilot可能会导致你的原始问题解决技能下降
• Copilot可能会提出过时或已被废弃的方法，因此请务必与当前文档进行交叉参考
• 请注意，Copilot的建议基于公开代码，不一定总是符合最新的最佳实践
• Copilot可能不了解你的项目需求和背景，因此请务必根据需要调整建议

通过遵循这些指南，利用 GitHub Copilot 可以帮助您更快地开发，同时保持代码质量、提高安全性并确保与项目标准的一致性。记住，与您的专业知识和批判性思维技能结合使用时，它会发挥最佳效果。Copilot 是个强大的工具，但与您的专业知识和批判性思维技能结合使用时，它会发挥最佳效果。

让我们来看看GitHub Copilot如何帮助提升您的测试和故障排除流程。

让Copilot为你生成函数单元测试：

• 写完一个函数后，在代码中添加注释如“// 为这个函数生成单元测试用例：”

• Copilot 可以建议涵盖不同场景和输入类型的测试用例

• 使用 Copilot 创建测试数据集和模拟对象（mock对象）

• 要求特定的测试框架，例如“# 为这个类编写 pytest 测试：”

• 使用 Copilot 生成正面和负面的测试用例

比如说：

    def add_numbers(a: int, b: int) -> int:  
        return a + b  

    # 为 add_numbers 函数编写一些单元测试如下  
    def test_add_numbers():  
        assert add_numbers(2, 3) == 5  
        assert add_numbers(-1, 1) == 0  
        assert add_numbers(0, 0) == 0  
        assert add_numbers(-5, -7) == -12

2. 使用 Copilot 帮忙找出可能的边缘情况来进行测试

• 让Copilot帮忙找出边缘情况，例如：“// 为测试此函数提供边缘情况建议：”
• 使用Copilot生成可能导致错误或意外行为的输入示例
• 利用Copilot创建压力测试或性能测试用例
• 请求边界值测试，例如：“# 为此方法生成边界值测试：”

例子：

    def divide_numbers(a: float, b: float) -> float:  
        return a / b  

    # 用于测试 divide_numbers 函数的一些特殊情况.
    def test_divide_numbers_edge_cases():  
        assert divide_numbers(1, 1) == 1  
        assert divide_numbers(0, 1) == 0  
        assert divide_numbers(-1, 1) == -1  
        assert abs(divide_numbers(1, 3) - 0.3333) < 0.0001  
        with pytest.raises(ZeroDivisionError):  
            divide_numbers(1, 0)

1. 让Copilot帮助你在调试时，让它解释错误信息并给出修复建议。

• 粘贴错误信息并请求Copilot解释下这个错误，例如：“// 解释下这个错误：”
• 使用Copilot来建议可能导致这个错误的原因，例如：“# 这个函数为什么会返回None？”
• 让Copilot给出调试策略，例如：“// 为这个问题建议调试步骤：”
• 使用Copilot生成日志语句或调试输出语句

例子：比如

    # 解释这个错误：IndexError: list index out of range  
    # 当你尝试使用一个不存在的索引来访问列表元素时，这个错误就会发生。  
    # 常见原因：  
    # 1. 试图访问一个空列表  
    # 2. 使用一个大于或等于列表长度的索引  
    # 3. 使用一个超出界限的负索引  

    # 建议的修复方式：  
    def get_element(lst, index):  
        if 0 <= index < len(lst):  
            return lst[index]  
        else:  
            return None  # 或者抛出自定义异常（如：IndexOutOfBoundsException）

1. 让 Copilot 帮你改写代码，让它更容易测试。

• 让Copilot提供建议来提高代码的测试性，例如：“// 将此代码重构为更易测试：”
• 利用Copilot将复杂逻辑拆分到独立且可测试的函数里
• 让Copilot实施有助于提高测试性的设计模式，如依赖注入等
• 借助Copilot来建议如何模拟外部依赖

例子，比如：

    # 原代码
    def process_data(data):  
        result = perform_complex_calculation(data)  
        save_to_database(result)  
        send_notification(result)  

    # 重构此代码以提高可测试性  
    def 执行复杂计算(data):  
        # 执行复杂计算  
        return result  

    def 保存到数据库(result):  
        # 保存到数据库  
        pass  

    def 发送通知(result):  
        # 发送通知  
        pass  

    def process_data(data, db_saver, notifier):  
        result = 执行复杂计算(data)  
        db_saver(result)  
        notifier(result)  

    # 现在你可以轻松独立测试每个函数，并在测试中模拟 db_saver 和 notifier

最佳的做法：

• 始终检查并理解Copilot生成的测试
• 根据业务需求补充Copilot的测试建议
• 以Copilot生成的测试为起点，然后进行扩展和细化
• 将Copilot与其他测试工具和实践（例如代码覆盖率分析和集成测试）相结合

通过这种方式利用 GitHub Copilot，你可以大大简化你的测试和排错流程。然而，请记住，虽然 Copilot 是一个强大的工具，它应该补充而不是替代你对测试和调试的知识。使用 Copilot 的建议时，要时刻保持自己的判断和专业水平。

Claude 3.5 十四行诗及使用 GitHub Copilot 介绍

Claude 3.5 诗作介绍了使用 GitHub Copilot 工具进行软件开发的四个关键步骤，并详细地提供了在开发各个阶段使用 Copilot 的全面指南。

步骤简介

1. 用GitHub Copilot来理解项目内容:

• 对初学者非常有用: 非常实用，因为它可以让初学者快速理解现有代码，理解函数和结构，并能提出改进意见。
• 对专业人士同样非常有用: 同样有用，但更多是作为额外的工具来提供深入理解并使代码现代化。

1. 与 GitHub Copilot 一起寻找解决方案,

• 适合小白: 可以快速生成模板代码并提供各种问题解决方法的建议，非常适合学习和尝试。
• 适合专业人士: 专业人士可以使用Copilot更快地生成更复杂的算法并进行优化。

3. 即时回答并检查

• 非常适合初学者: 适用于快速获取代码片段和函数实现，但会提醒检查正确性和安全性，
• 非常适合专业人士: 专业人士可以利用此功能进行快速查阅和获得更多建议，但需要进行彻底的质量检查。

4. 测试和故障排除更简单了：

• 适合初学者使用，: 可以创建测试并找出边界情况，有助于理解测试。
• 适合专业人士使用，: 可以加速测试和调试过程，但需要专业人士来验证和补充测试。

实用技巧和建议：

• 将 Copilot 的建议作为起点，而不是直接采用它作为最终答案：始终将 Copilot 的建议作为起点，而不是直接采用它作为最终答案。将建议与您的专业知识和批判性思维相结合至关重要。
• 验证与确认：无论经验水平如何，每个建议都应在实施前仔细审查和测试，确保其可靠性和适用性。
• 保持一致性：确保 Copilot 生成的代码符合您团队的编码标准和最佳实践。

金点子建议

• 自动化文档创建: 利用Copilot创建函数和类的文档，这有助于更好地理解代码并快速让新成员上手。
• 与其他工具集成: 考虑将Copilot与持续集成和部署(CI/CD)工具集成，以自动化和加速开发和测试过程。
• 教育资源: 开发围绕Copilot的教程和培训资源，使用户能够快速熟悉该工具并在工作中有效利用它。

结论篇：此处可添加对结论的简要概述或过渡句，以保持流畅的中文语调。

克劳德 3.5 十四行诗已经成功提供了与 GitHub Copilot 协作的实用且详细的指南。他为理解、寻找解决方案、获取即时答案和测试排错提供了基础步骤。这些回复对新手和专家都非常有用。关键是始终将你的专业知识和批判性思维与 Copilot 这样的工具结合起来。