什么值得买App下载 App ›
连续签到专享现金活动

让AI写出靠谱代码,你得先学会下需求

一、万能提示词模板
1、结构化提问公式直接套用
AI不是读心术,而是执行引擎。你给的信息越模糊,它越靠概率“猜”——而猜出来的代码,往往能跑但埋雷。真正有效的提示词,必须包含五个不可省略的模块:角色、上下文、任务、约束、输出格式。以下是一个可直接复制粘贴的通用模板:

```markdown
你是一名[在此处填写角色,如:资深Python后端工程师]

项目背景:
- 技术栈:[例如:Flask 2.3 + SQLAlchemy + PostgreSQL]
- 当前文件路径:[例如:/app/services/order_service.py]
- 相关上下文:[在此处粘贴报错日志 / 接口文档片段 / 调用链路描述]

请完成以下任务:
[在此处清晰描述你要实现、修复或解释的具体功能]

约束条件:
- 不要修改[指定不能动的文件或函数]
- 必须使用[指定技术,如:bcrypt加密、JWT鉴权]
- 兼容性要求:[如:支持Python 3.8+]
- 禁止行为:[如:不要使用全局变量、不要省略异常处理]

输出要求:
- 只返回[代码 / Markdown格式解释 / 单元测试]
- 代码需带中文注释和类型注解
- 不要包含任何解释性文字
```

这个模板的核心在于:把AI当作一个新入职的程序员,你不是在聊天,而是在写一份简洁但完整的需求说明书。
123
2、不同编程任务的微调变体
任务类型关键差异点模板侧重字段
写新功能强调输入输出契约与技术栈适配需提供输入示例、预期输出格式、框架版本
修Bug聚焦错误现象与预期行为对比必须粘贴完整错误日志、复现步骤、期望正确结果
重构代码明确性能指标与风格规范需指定时间复杂度目标、命名规范(如PEP8)、是否保留兼容接口

三种高频场景下提示词的关键调整点

二、上下文投喂技巧
1、必要代码片段筛选标准
给AI看太多代码,反而会稀释关键信息。正确的做法是提供“最小可复现单元”:保留报错行前后各20行代码,包含当前文件的import语句、相关函数定义、以及调用该函数的上下文片段。例如,若报错发生在order_service.py第45行,就应包含第25–65行,并确保函数签名、参数类型、依赖注入方式完整可见。

严禁直接粘贴整个项目文件或node_modules目录内容——这不仅浪费token,还会让AI注意力分散到无关逻辑上。记住:AI不需要知道你的整个项目,只需要知道“此刻正在发生什么”。
145
2、项目结构与技术栈描述
让AI理解项目整体架构,只需三句话:
1. 项目类型:如“基于React 18的SPA后台管理系统”;
2. 核心依赖版本:如“Python 3.10, Django 4.2, Redis 7.0”;
3. 关键配置文件名称:如“package.json、settings.py、Dockerfile”。

无需提供这些文件的完整内容,除非问题直接涉及配置逻辑(如环境变量加载失败)。AI只需要知道“你在什么环境下工作”,就能避免生成不符合项目规范的代码——比如在Django项目里用Flask路由语法。
36
三、迭代优化策略
1、代码审查与修正指令
  • 语法错误
    “第12行出现NameError: name 'user_id' is not defined,请检查变量作用域并修正。”
    7
  • 逻辑漏洞
    “calculate_discount函数未处理vipLevel为负数的情况,请补充边界校验并抛出IllegalArgumentException。”
    8
  • 性能低下
    “这段代码在循环内执行数据库查询,存在N+1问题。请改用批量查询,并将时间复杂度优化至O(n)。”
    9
  • 风格不符
    “函数命名不符合snake_case规范,请将getUserInfo改为get_user_info,并遵循PEP8缩进规则。”
    10
2、分步生成复杂逻辑
复杂功能不要一次性丢给AI。拆解为四个步骤:

**先定义接口**:让AI输出函数签名、参数类型、返回值结构,你确认后再进入下一步。

**再实现核心逻辑**:基于已确认的接口,生成不含异常处理的主干代码,人工验证逻辑正确性。

**接着补单元测试**:要求AI为该函数生成覆盖正常、边界、异常场景的测试用例,运行通过后再继续。

**最后加异常处理**:补充空值校验、权限检查、资源释放等防御性代码。

每一步都需人工验收。AI擅长执行小任务,但不擅长理解大需求的整体一致性。
56
四、高质量代码验收
1、安全性与边界检查清单
  • SQL注入风险
    验证所有拼接SQL语句是否使用参数化查询。可追问AI:“这段代码是否存在SQL注入风险?请逐行分析。”
    7
  • 硬编码敏感信息
    检查代码、日志、配置中是否包含密钥、密码、Token。使用正则搜索“password”“secret”“key”。
    9
  • 未处理的Null指针
    对所有用户输入、外部API返回值做空值校验。人工模拟传入None、空字符串、空列表测试。
    11
  • 无限循环风险
    检查递归函数是否有终止条件,while循环是否有退出机制。用小数据集手动推演执行路径。
    12
  • 依赖包版本兼容性
    核对AI推荐的第三方库是否与项目requirements.txt中的版本冲突,避免引入废弃API。
    13
2、代码解释与维护性评估
不懂的代码不要上线。即使AI生成的代码能跑通,你也必须理解其每一行逻辑。最有效的方法是让AI“像教初学者一样解释这段代码”。标准指令如下:

“请用通俗语言解释以下代码的执行流程,假设我是刚入门的开发者。重点说明:1)关键变量的作用;2)分支判断的业务含义;3)可能的扩展点。”

同时要求AI生成:
- 函数级docstring
- 复杂算法的流程图文字描述(如“快排:选基准→分区→递归左右”)
- 后续可能需要修改的钩子位置(如“此处可插入缓存逻辑”)

人机协作的本质,不是让AI替你思考,而是让它帮你表达思考。
814
五、常见问题与避坑指南
常见问题避坑指南
  • AI生成的代码看似运行正常但存在隐蔽逻辑错误,务必编写单元测试进行验证13
  • 不要直接信任AI提供的第三方库引用,需自行核对官方文档确认API是否过时或废弃15
  • 涉及敏感数据(如密钥、用户隐私)时,严禁直接粘贴到公共AI模型中,需使用脱敏数据或本地部署模型9
  • AI倾向于生成冗长的解释性文字,可在提示词末尾添加“只输出代码,不要解释”以节省阅读时间10
  • 遇到AI反复无法解决的Bug,尝试更换不同的AI模型或重置对话上下文,避免陷入思维定势16

评论

评论区空态插画

当前文章无评论,是时候发表评论了