AI辅助的软件开发 (2)

这是一个三部分系列中的第二篇，每个部分都将详细介绍如何在处理软件开发中特定过程时正确地将AI集成到您的工作流程中。

PART2：使用AI构建 — 代码生成、数据库设计和文档

欢迎来到这个关于AI辅助软件开发的系列文章的第二部分。在这篇文章中，我们将探索AI如何加速您的编码过程，帮助设计高效的数据库，并协助创建全面的文档。我将提供实用的提示和技术，以充分利用AI在这些关键软件开发方面的优势。

1、掌握AI辅助的代码生成

到目前为止，我们已经规划了项目并设计了架构。现在是时候进入主要内容了：实际编写一些代码！

1.1 为代码生成编写有效的提示

英语可能是21世纪学习的最佳编程语言！从AI助手那里获得优秀代码的关键在于你如何传达你的请求。我了解到（有时是通过痛苦的方式）模糊的提示会导致模糊的代码。这是我用于请求代码的标准模板：

我需要在[编程语言]中实现[特定功能]。  
主要需求：  
1. [需求1]  
2. [需求2]  
3. [需求3]  
请考虑：  
- 错误处理  
- 边缘情况  
- 性能优化  
- [语言/框架]的最佳实践  
请不要不必要地删除任何注释或代码。  
生成带有清晰注释解释逻辑的代码。

这种结构化的方法有助于AI准确理解你需要什么，并考虑你可能忘记明确提到的重要方面。

1.2 审查和理解AI生成的代码

现在，这里有一个关键点：永远不要盲目地复制粘贴AI生成的代码到你的项目中。我早期犯过这个错误，并花了数小时调试问题，而这些问题本来可以通过仔细审查就能发现。

当你收到AI生成的代码时，请遵循以下步骤：

通读整个代码片段：了解整体结构和方法。
检查逻辑错误：AI可能会误解某个需求或做出错误假设。
查看最佳实践：确保代码符合你的语言和项目的约定。
验证错误处理：确保边缘情况和潜在错误得到适当处理。
理解每一行代码：如果你有任何不明白的地方，请让AI解释它。

这里是我用来获取解释的提示：

你能详细解释以下代码部分吗：  
[粘贴代码段]  
具体来说：  
1. 这个部分的目的是什么？  
2. 它是如何一步一步工作的？  
3. 这种方法是否有任何潜在问题或限制？

1.3 利用AI进行代码审查和改进

我最喜欢在编码中使用AI的一个用途就是代码审查。这就像有一个不知疲倦的高级开发人员在你的肩膀上看着你，捕捉你可能忽略的问题并提出改进建议。

尝试这个代码审查的提示：

请审查以下代码：  
[粘贴你的代码]  
考虑：  
1. 代码质量和遵循最佳实践  
2. 潜在的bug或边缘情况  
3. 性能优化  
4. 可读性和可维护性  
5. 任何安全问题  
建议改进并解释每条建议的理由。

我发现AI经常能够发现我忽视的细微问题，尤其是当我长时间盯着代码看时。

1.4 不同编码任务的提示想法

为了帮助你开始使用AI辅助编码，这里有一些常见任务的提示想法：

对于实现特定算法：

在[编程语言]中实现[算法名称]。  
请包括：  
1. 带有明确参数和返回类型的主函数  
2. 如果有必要，包含辅助函数  
3. 时间和空间复杂度分析  
4. 示例用法

对于创建类或模块：

在[编程语言]中为[特定功能]创建一个[类/模块]。  
包括：  
1. 构造函数/初始化  
2. 带有明确docstring的主要方法  
3. 必要的私有辅助方法  
4. 正确封装并遵守OOP原则

对于优化现有代码：

这里有需要优化的一段代码：  
[粘贴代码]  
请提出优化建议以提高其性能。对于每个建议，请解释预期的改进以及任何权衡。

对于编写单元测试：

为以下函数生成单元测试：  
[粘贴函数]  
包括测试：  
1. 正常预期输入  
2. 边缘情况  
3. 无效输入  
使用[首选测试框架]语法。

2、AI编码工作流：逐步指南

基于我的经验，这是我发现最有效的AI辅助编码工作流：

从明确的规范开始：尽可能清楚地定义你要构建的内容。
生成初始代码：使用详细的提示让AI生成初稿。
审查和理解：仔细审查代码，确保你理解每一部分。
迭代和精炼：向AI请求解释、优化和替代方案。
测试和调试：使用AI帮助生成单元测试并调试任何问题。
优化和重构：一旦代码运行正常，使用AI提出优化和重构建议。
文档：使用AI帮助生成清晰的代码文档。

3、警惕过度依赖的陷阱

虽然AI是编码的强大工具，但保持健康的平衡至关重要。这里有一些我遇到（并从中吸取教训）的陷阱：

失去大局观：有时，在与AI的反复交流中，很容易失去对整体架构和设计的关注。始终记住你的总体目标。
接受过于复杂的解决方案来解决简单问题：AI有时可能会建议过于复杂的解决方案。除非确实需要复杂性，否则始终追求简单性。
忽视学习底层概念：使用AI生成的代码而不完全理解它是很诱人的。抵制这种冲动！始终花时间去学习和理解。
忽略性能影响：AI可能不会立即生成最高效的代码。始终考虑性能影响，特别是在系统的关键部分。

4、使用AI进行数据库设计和查询优化

无论你是否有数据库设计的经验，AI都可以在这个领域成为改变游戏规则的工具。AI可以帮助我们创建健壮的数据库模式，并编写连最有经验的DBA也会点头认可的查询。

4.1 利用AI进行数据库模式设计

谈到数据库模式设计时，AI可以是一个非常有价值的头脑风暴伙伴。这是我经常用来开始的提示：

我正在为[描述你的应用程序]设计数据库。主要实体是：  
[列出主要实体]  

主要需求：  
1. [需求1，例如“必须支持快速检索用户帖子”]  
2. [需求2，例如“需要跟踪用户关系（粉丝/关注者）”]  
3. [需求3，例如“必须处理大量时间序列数据用于分析”]  

请建议一个数据库模式，包括：  
1. 表及其列（带合适的数据类型）  
2. 主键和外键关系  
3. 必要的连接表用于多对多关系  
4. 建议的索引以提高性能  
5. 考虑可扩展性  

此外，请解释你的设计选择的原因。

这个提示确保AI不仅考虑基本结构，还考虑性能和可扩展性方面。

4.2 优化模式

一旦你有了初始模式，就需要对其进行优化。在这里，AI可以真正发光，帮助你思考不同的场景：

给定以下初始模式：  
[在此处粘贴你的模式]  

请考虑以下内容进行分析：  
1. 规范化：模式是否被正确规范化？如果不是，请提出改进意见。  
2. 非规范化：是否存在非规范化可以提高性能的情况？  
3. 索引策略：建议额外的索引以提高查询性能。  
4. 扩展性：该模式如何应对增长？存在哪些潜在瓶颈？  
5. 数据完整性：是否存在应考虑的约束或触发器以确保数据一致性？  
对于每个建议，请解释其优缺点。

4.3 编写优化的查询

现在，让我们谈谈查询优化。这是我发现AI在这方面特别有帮助的地方，尤其是在面对复杂查询时。这里是我用于查询优化的提示：

我需要优化以下SQL查询：  
[粘贴你的查询]  

该查询在大数据集上执行时间过长。请：  
1. 分析查询并识别潜在的性能问题。  
2. 提出优化建议，可能包括：  
   - 重写查询  
   - 添加或修改索引  
   - 如果必要，建议模式更改  
3. 解释每个优化背后的理由。  
4. 如果可能，请提供我们可能期望的性能改进估计。  
附加信息：  
- 数据库系统：[例如，PostgreSQL，MySQL]  
- 大约表大小：[例如，Users表有1百万行]  
- 任何相关的硬件限制

这个提示不仅可以帮助你优化特定查询，还可以提供可以应用于其他数据库交互的见解。

4.4 数据库相关任务的提示想法

为了帮助你在数据库工作中最大限度地利用AI，这里是一些更具体的提示想法：

对于索引优化：

给定以下表结构和常用查询：  
[粘贴表结构和示例查询]  

请建议一个最优的索引策略。考虑：  
1. 应该索引哪些列？  
2. 我们应该使用单列还是多列索引？  
3. 是否存在覆盖索引会受益的情况？  
4. 这些索引如何影响写入性能？

对于数据迁移计划：

我需要将数据从旧模式迁移到新模式：  
旧模式：  
[粘贴旧模式]  

新模式：  
[粘贴新模式]  

请帮我创建一个迁移计划：  
1. 确定将数据转换所需的步骤  
2. 建议任何中间表或视图可能有用  
3. 考虑数据完整性和如何处理潜在冲突  
4. 提出一种策略以验证迁移的成功

对于查询性能故障排除：

以下查询执行效果不佳：  
[粘贴有问题的查询]  

执行计划：  
[如果可用，请粘贴执行计划]  

请分析此查询并提出改进建议：  
1. 识别查询或执行计划中的任何次优部分  
2. 建议编写查询的替代方式  
3. 是否存在缺失的索引可以有所帮助？  
4. 是否对模式的任何部分进行非规范化可以提高此查询的性能？

4.5 AI辅助的数据库性能调优

我发现AI在整体数据库性能调优方面特别有帮助。这里是我用于一般性能审查的提示：

我打算改善数据库的整体性能。以下是概览：  
- 数据库系统：[例如，PostgreSQL 13]  
- 当前大小：[例如，500GB]  
- 主要表及其大小：[列出主要表]  
- 常见查询模式：[描述典型查询]  
- 当前痛点：[例如，在大型表上的慢速联接，高峰时段的写入性能差]  

请提供一个全面的性能调优计划，包括：  
1. 可能需要调整的配置参数  
2. 索引策略审查  
3. 查询优化技术  
4. 潜在的模式优化  
5. 缓存策略  
6. 其他任何有助于提高性能的相关建议  
对于每个建议，请解释预期的影响和任何潜在的权衡。

这种全面的审查可以为你提供数据库优化的坚实路线图，通常会突出你可能没有考虑到的领域。

5、警惕：数据库设计中的人类因素

尽管AI是数据库工作的强大工具，但记住人类因素的重要性至关重要：

业务逻辑理解：AI可以建议最优结构，但你需要确保它们与你的特定业务需求和未来的可扩展性要求相匹配。
数据敏感性：注意数据隐私和安全问题，AI可能不了解你特定上下文中的这些因素。
在真实条件下测试：始终在模拟生产环境的条件下彻底测试AI建议的优化。
持续学习：将AI作为学习工具。不要只是实施其建议，而是努力理解背后的原则。
定期审查：随着应用的发展，数据库需求也会变化。定期使用AI辅助审查数据库设计和性能。

6、文档制作变得简单

我知道对我们许多人来说，编写文档感觉像是一项苦差事，但如果我告诉你，借助AI，文档实际上可以成为一个令人愉快且极其高效的部分呢？这里有一些关于如何使用AI来转变你处理文档方式的技巧。

6.1 使用AI生成文档

优秀的AI生成文档的关键在于你如何提示AI。这是我发现非常有效的模板：

我需要为[项目/组件名称]创建文档。请生成：  
  
1. [项目/组件]的概述  
2. 安装说明  
3. 配置选项  
4. API参考（如果适用）  
5. 使用示例  
6. 故障排除指南  
7. 常见问题解答部分  
  
对于每个部分，请考虑：  
- 目标受众（例如，开发者，最终用户）  
- 任何前提条件或依赖项  
- 常见陷阱或误解  
- 最佳实践  
  
请使用清晰简洁的语言，并在适当的地方包含相关的代码片段。

这个全面的提示确保你的AI助手涵盖了良好文档的所有关键方面。

6.2 为准确性和清晰性细化AI生成的文档

现在，就像代码生成一样，你不能仅仅接受AI的输出就结束了。这是我对细化AI生成文档的过程：

审查准确性：通读文档，确保所有信息与你的实际代码和预期功能一致。
检查清晰度：确保解释清晰易懂，适合你的目标受众。
验证代码片段：测试任何包含的代码示例，确保它们按预期工作。
添加项目特定细节：结合AI可能不知道的任何独特项目方面。
增强视觉效果：考虑在哪里加入图表、流程图或屏幕截图可以增强理解。

这里是我用来细化特定部分的提示：

请审查并改进以下文档部分：  
[粘贴部分]  

考虑：  
1. 解释的清晰度  
2. 信息的完整性  
3. 针对目标受众的适当细节水平  
4. 技术写作的最佳实践  
建议改进并解释你的理由。

6.3 不同类型的文档的不同提示想法

你的项目的不同方面可能需要不同的文档方法。这里是一些针对特定文档需求的提示：

对于API文档：

为以下端点生成API文档：  
[粘贴端点详情]  
包括：  
1. 端点URL和方法  
2. 请求参数及其类型  
3. 请求体格式（如果适用）  
4. 响应格式和可能的状态码  
5. 示例请求和响应  
6. 任何身份验证要求  
7. 速率限制信息（如果适用）

对于README文件：

为我的GitHub仓库创建一个README.md文件。项目是[简要描述]。包括：  
1. 项目标题和描述  
2. 安装说明  
3. 使用示例  
4. 贡献指南  
5. 许可证信息  
6. 徽章（例如，构建状态，版本等）  
使用适当的Markdown格式，并考虑添加目录以便于导航。

对于用户指南：

为[产品/功能名称]生成用户指南。目标受众是[描述受众]。包括：  
1. 产品/功能的介绍和目的  
2. 入门指南  
3. 主要功能及如何使用它们  
4. 高级使用技巧  
5. 常见问题的故障排除  
使用简单的语言，并考虑包括带有假设截图占位符的分步说明。

对于代码注释和docstrings：

为以下代码生成适当的注释和docstrings：  
[粘贴代码]  
遵循[语言特定]的docstrings惯例。包括：  
1. 函数/类的简要描述  
2. 参数及其类型  
3. 返回值及其类型  
4. 可能引发的任何异常  
5. 如果函数/类的用法不明显，则包括使用示例

6.4 利用AI进行活文档

我发现使用AI进行文档制作最酷的一种方式是维护“活文档”——文档随着项目的发展而演变。这是我的做法：

版本化文档：将文档与代码一起放在版本控制系统中。
随代码变更更新文档：每次进行重大代码变更时，使用以下提示：

我已对代码进行了以下更改：  
[总结更改]  
请更新相关文档部分以反映这些更改。  
突出显示任何用户应注意的破坏性更改或新功能。

定期审查：根据项目进度，每隔几周或几个月使用以下提示：

请审查以下文档：  
[粘贴当前文档]  
考虑到最新的最佳实践和类似项目的常见用户痛点：  
1. 建议任何需要添加或扩展的部分  
2. 识别任何可能过时或不再相关的部分  
3. 推荐改进以提高清晰度和用户友好性

这种方法确保文档保持最新，并继续有效地服务于用户。

6.5 AI辅助文档的隐藏好处

现在，让我分享一下使用AI进行文档制作时令我惊讶的一些事情。我发现，在创建和细化文档的过程中，我经常会改进实际代码。

为什么？因为向AI（进而向未来的用户）解释概念时，我有时会意识到某些代码部分并不像我认为的那样直观或结构良好。这促使我重构和改进代码本身。

此外，由AI生成的全面文档有时帮助我识别我未曾考虑过的边缘情况或潜在功能。这就像有一个全面、公正的评审员同时审查我的代码和思维过程。

7、警惕：人类触感仍然至关重要

AI不应取代人类监督和输入的需求。在撰写文档时，这里有一些需要注意的事情：

项目特定知识：AI无法知道你特定项目背后的独特背景或决策。确保注入这些个人知识到文档中。
用户同理心：虽然AI可以写出清晰的指令，但你最了解你的用户。始终从用户的角度审查文档。
品牌和语气：如果你的项目或公司有特定的语气或风格指南，你需要相应地调整AI生成的内容。
敏感信息：在向AI提供提示时，小心不要包含任何敏感或专有信息。

当我们结束这一部分时，我希望你对编码、设计和文档有了新的认识。软件工程中那些枯燥的部分不再需要成为负担。使用AI可以成为你开发过程中不可或缺的一部分，从而提升你的代码和用户的体验。

本系列的下一篇文章将涵盖测试、优化、版本控制，当然还有大量的提示想法！

原文链接：AI-Assisted Software Development: A Comprehensive Guide with Practical Prompts (Part 2/3)

汇智网翻译整理，转载请标明出处