AI编程中的提示词模板分享

用AI编程这一年多,我积累了一批比较好用的Prompt模板。每次遇到特定场景直接套模板,效率比临时想Prompt高太多了。今天把我用得最多的几个模板分享出来,都是可以直接复制使用的,希望对大家有帮助。

场景一:新建项目

开始一个新项目的时候,需要让AI帮你搭建项目骨架。这个场景最重要的是把需求和约束说清楚。

模板:

我需要创建一个新项目,请帮我搭建项目结构。

项目信息:
- 项目名称:[名称]
- 项目类型:[Web应用/API服务/CLI工具/库]
- 技术栈:[语言/框架/数据库]
- 主要功能:[简要描述核心功能]

技术要求:
- 包管理器:[npm/pnpm/yarn]
- 代码规范:[ESLint配置/Prettier]
- 测试框架:[Jest/Vitest/pytest]
- 目录结构偏好:[按功能分/按类型分]

请生成:
1. 完整的目录结构
2. 核心配置文件(package.json/tsconfig等)
3. 基础代码框架
4. README模板

使用技巧:技术栈和要求写得越具体,AI生成的代码越接近你想要的。如果你有参考项目,可以加一句"参考XX项目的目录结构"。

场景二:Bug修复

这是我用得最频繁的模板。关键是提供足够的上下文信息,让AI能快速定位问题。

模板:

我遇到了一个Bug,需要帮助排查和修复。

问题描述:
- 预期行为:[应该发生什么]
- 实际行为:[实际发生了什么]
- 复现步骤:[1. 2. 3.]

错误信息:
[粘贴完整的错误日志/堆栈跟踪]

相关代码:
[粘贴相关的代码片段,标注文件路径]

已经尝试过:
[列出你已经尝试过的解决方法]

环境信息:
- 运行环境:[Node版本/Python版本/OS]
- 相关依赖版本:[关键库的版本号]

使用技巧:很多人debug的时候只扔一个错误信息就让AI修,效果往往不好。把"已经尝试过"这部分填上去,能避免AI给你重复的建议。环境信息也很重要,很多Bug是特定版本才有的。

场景三:代码审查

让AI帮你做Code Review,可以在提PR之前先自查一遍。

模板:

请对以下代码进行审查,从以下维度给出改进建议:

审查维度:
1. 代码质量:可读性、命名规范、代码组织
2. 潜在Bug:空值处理、边界条件、异常处理
3. 性能:时间复杂度、内存使用、不必要的计算
4. 安全性:输入验证、SQL注入、XSS等
5. 可维护性:模块化程度、耦合度、可测试性

代码上下文:
- 这段代码的功能是:[简述功能]
- 所在模块:[模块名称和作用]
- 调用方:[谁会调用这段代码]

[粘贴代码]

请按照严重程度排序,对每个问题给出:
- 问题描述
- 严重程度(高/中/低)
- 修改建议(附代码示例)

使用技巧:审查维度可以根据项目的重点来调整。比如做ToC产品的时候安全性这块权重要高一些,做内部工具的时候可以更关注可维护性。

场景四:代码重构

需要重构一段代码的时候,明确重构目标很重要。

模板:

我需要重构以下代码,请在保持功能不变的前提下改进代码质量。

当前代码的问题:
- [具体问题1,比如:函数过长,超过200行]
- [具体问题2,比如:多层嵌套的if-else]
- [具体问题3,比如:重复代码过多]

重构目标:
- [目标1,比如:拆分成多个单一职责的函数]
- [目标2,比如:用策略模式替代if-else]
- [目标3,比如:提取公共逻辑到工具函数]

约束条件:
- 不改变对外接口(函数签名、返回值格式)
- 不引入新的外部依赖
- [其他约束]

当前代码:
[粘贴代码]

请提供:
1. 重构后的完整代码
2. 重构思路说明
3. 需要同步修改的调用方代码(如果有)

使用技巧:约束条件一定要写清楚。AI重构的时候容易"过度设计",加了一堆你不需要的设计模式。明确告诉它不要改接口、不要加依赖,能得到更实用的结果。

场景五:写测试

这是AI非常擅长的场景,用好了能省很多时间。

模板:

请为以下代码编写单元测试。

被测代码:
[粘贴代码]

测试要求:
- 测试框架:[Jest/Vitest/pytest/其他]
- 覆盖率目标:[语句覆盖率/分支覆盖率]
- Mock策略:[需要mock的外部依赖]

请覆盖以下测试场景:
1. 正常流程(Happy Path)
2. 边界条件(空值、空数组、最大值、最小值)
3. 异常处理(网络错误、参数错误、超时)
4. 并发场景(如果适用)

输出格式:
- 每个测试用例有清晰的描述
- 使用 describe/it 分组
- 遵循 AAA 模式(Arrange-Act-Assert)

使用技巧:让AI写测试的时候最容易出的问题是只写Happy Path的测试。明确要求覆盖边界条件和异常处理,AI才会生成全面的测试用例。另外Mock策略最好自己指定,AI有时候会Mock过多或过少。

场景六:写文档

让AI帮写技术文档和注释。

模板:

请为以下代码/API编写文档。

文档类型:[API文档/使用说明/内部技术文档]
目标读者:[新入职开发者/前端开发者/运维人员]

代码/API信息:
[粘贴代码或API定义]

文档应包含:
1. 概述:功能说明和使用场景
2. 快速开始:最简单的使用示例
3. API参考:每个函数/接口的详细说明
   - 参数说明(类型、是否必填、默认值)
   - 返回值说明
   - 使用示例
4. 注意事项和常见问题
5. 更新日志格式

风格要求:
- 语言简洁,避免过度文学化
- 代码示例要可直接运行
- 关键概念用粗体标注

使用技巧:目标读者这个字段很关键。给新人写的文档要详细、给资深开发写的要简洁,AI会根据这个来调整内容的深度和表达方式。

场景七:性能优化

让AI帮忙分析和优化代码性能。

模板:

以下代码存在性能问题,请帮我分析并优化。

性能问题描述:
- 具体表现:[比如:接口响应时间从100ms增长到了2s]
- 数据规模:[比如:处理10万条数据时出现问题]
- 瓶颈猜测:[如果有的话]

代码:
[粘贴代码]

运行环境:
- 运行平台:[浏览器/Node.js/Python]
- 硬件配置:[CPU/内存,如果相关]
- 并发量:[如果是服务端代码]

优化约束:
- 可读性优先/性能优先
- 是否可以引入新依赖
- 是否可以改变数据结构

请提供:
1. 性能瓶颈分析
2. 优化方案(按效果排序)
3. 每个方案的代码实现
4. 优化前后的时间/空间复杂度对比

通用使用技巧

最后分享几个跨场景的通用技巧。

第一,给AI足够的上下文。很多人给的信息太少,AI只能猜,结果自然不好。宁可多写几行背景信息,也别让AI猜你的意图。

第二,分步骤来。复杂的任务不要一个Prompt全塞进去,拆成几个步骤效果更好。先让AI做方案设计,确认之后再让它写代码。

第三,迭代优化。第一次的结果不满意很正常,把不满意的地方具体说出来让AI修改。比起重新写一个Prompt,在已有结果上迭代效率更高。

第四,建立自己的模板库。今天分享的是通用模板,你应该根据自己的技术栈和工作场景来定制专属的模板。用多了之后会越来越顺手。

这些模板你们觉得好用吗?你有没有自己积累的好用Prompt模板?欢迎在评论区分享,咱们一起完善这个模板库,让AI编程更高效。

分享几个我常用的提示词模板,经过大量实测优化的:

代码review模板:

请review以下代码,关注:1.潜在bug 2.性能问题 3.安全漏洞 4.代码风格。对每个问题给出严重等级(P0-P3)和修改建议。不要重写代码,只指出问题。

调试模板:

我遇到了以下错误[贴错误]。代码上下文是[贴代码]。请分析可能的原因,按概率从高到低排列,并给出每个原因的验证方法。

架构设计模板:

我需要设计一个[系统描述]。约束条件:[列出约束]。请给出2-3个可选方案,对比各自的优缺点,并推荐最适合的方案及理由。

关键原则是:给AI足够的上下文和约束条件,不要让它自由发挥。越具体的prompt,产出越靠谱。

@ailianghub review模板我也用类似的,但有个改进建议:加上「请参考项目已有的代码风格」这个约束。否则AI可能会按它自己的风格标准来review,跟你们团队的规范对不上。

另外分享一个写commit message的模板

根据以下diff生成commit message,格式为conventional commits,语言用英文,body部分简述why而非what。

简单但省了不少时间。

1 个赞

越用越依赖了哈哈。现在写代码之前先花5分钟写prompt,比直接开始写代码效率高多了。

不过有个建议:别把prompt模板当成万能的。不同模型对同一个prompt的响应差异很大,在Claude上好用的模板到GPT上可能效果一般。建议针对常用的模型分别调优。

1 个赞

收藏了!正好最近在整理自己的prompt库,楼主的模板可以直接用。

效率提升确实明显。我现在用prompt模板之后,写单元测试的速度快了大概3倍。

补充一个写测试用例的模板

为以下函数编写单元测试,要求覆盖:正常路径、边界条件、异常处理。使用[测试框架],每个测试case加上清晰的描述。

这个模板出来的测试质量还不错,但记得一定要review,AI偶尔会编造不存在的边界条件。

实用帖!我把这些模板整理成了一个Notion模板库,日常开发随时调用,推荐大家也这么做。

1 个赞

希望楼主能出一个进阶版,比如怎么用prompt做复杂的多文件重构、数据库schema设计之类的。基础模板已经掌握了,想学更高阶的用法。

1 个赞

模板只是起点,关键还是得根据具体场景调

收藏了,回头试试那个debug模板