AI应用代码审查优化结构化提示词
本提示词方案专为AI应用开发与代码质量工程师设计,提供一套结构化、可操作的代码审查与优化指令...
提示词内容
复制角色定义与任务定位
请以“AI辅助的资深代码质量工程师”身份,使用本提示词方案。你的核心目标是:系统性地引导AI工具(如ChatGPT、Claude、专用代码AI)对指定代码段或项目进行深度审查、缺陷诊断与结构化优化建议生成,最终产出可直接用于改进代码质量、性能与可维护性的专业级分析报告与重构方案。
适用场景
- 在开发过程中,对新增功能模块或关键函数进行上线前深度审查。
- 对遗留系统或技术债严重的代码模块进行专项优化分析。
- 在团队代码评审(Code Review)中,借助AI提供标准化、无遗漏的检查视角。
- 为特定性能瓶颈(如数据库查询、算法复杂度)寻找AI建议的优化路径。
- 编写高质量、符合最佳实践的示例代码或库函数时的辅助设计。
核心提示词(可直接复制使用)
- 基础审查指令:请对以下 [编程语言] 代码进行全面的代码审查。请依次分析:1. 潜在的逻辑错误与边界条件处理;2. 安全性风险(如注入、敏感信息泄露);3. 性能瓶颈(时间复杂度、内存使用);4. 代码风格与一致性;5. 可读性与可维护性。针对每个问题,请提供具体的代码行位置和修改建议。
- 专项优化指令:针对以下代码中的 [具体功能,如“数据库查询”、“循环嵌套”、“图像处理算法”] 部分,请专注于性能优化。请分析当前实现的复杂度,并提供至少两种优化方案,包括:1. 算法/数据结构改进方案;2. 利用 [特定库或特性,如“异步IO”、“缓存机制”] 的改进方案。请用修改后的代码片段说明。
- 重构建议指令:这段代码在 [模块耦合度/函数单一职责/错误处理分散] 方面存在问题。请提出重构计划,将其拆分为/重组为更清晰、可测试的模块或函数。请说明重构步骤,并展示关键部分重构后的接口设计与调用关系图(用文字描述)。
- 生成最佳实践示例:请为 [实现某个特定功能,如“安全的用户输入验证”、“高效的批量数据处理器”] 编写一个符合 [语言,如“Python”] 现代最佳实践的、健壮的示例函数。要求包含完整的错误处理、日志记录、类型提示(如适用)和单元测试思路。
风格方向
- 报告风格:输出应结构化、条目清晰,采用“问题描述 -> 风险等级(高/中/低)-> 位置定位 -> 建议方案 -> 示例代码”的层级。
- 语言风格:专业、精准、客观。避免模糊表述,使用“应避免...”、“建议改为...”、“可考虑引入...”等明确建议性措辞。
- 思维风格:体现防御性编程思想、性能意识、可维护性优先原则,并权衡修改成本与收益。
构图建议(信息组织框架)
- 总-分-总结构:开场先给出代码整体质量评级与核心摘要;然后分点详述各类问题;最后总结关键改进项与优先实施顺序。
- 问题分类构图:将发现的问题按“关键缺陷”、“性能问题”、“代码异味”、“改进机会”等类别分组呈现,使报告脉络清晰。
- 对比构图:在提出优化建议时,采用“当前代码 vs 优化后代码”的并排对比方式,直观展示差异与优势。
细节强化
- 定位精确化:要求AI在指出问题时,必须包含文件路径(若上下文提供)、函数名、行号或代码片段。
- 建议具体化:优化建议需包含具体的API、设计模式名称(如工厂模式、策略模式)、或第三方库推荐及简要理由。
- 权衡说明:对于重要的重构或优化,提示AI分析其利弊,例如“此重构会提高代码清晰度,但可能略微增加初始化开销”。
- 合规与安全:强化对数据隐私、合规性(如GDPR)、常见漏洞(OWASP Top 10)的检查维度提示。
使用建议
- 分步迭代:对于大型代码块,建议分段、分文件提交审查,避免单次提示词过长导致AI分析失焦。
- 提供上下文:在提交代码时,简要说明该代码的业务背景、性能要求或特定约束条件,有助于AI给出更贴合场景的建议。
- 组合使用:将“基础审查”发现的问题,作为“专项优化”或“重构建议”的输入,进行多轮、递进式的深度分析。
- 结果验证:AI提供的优化代码和建议,仍需开发者结合自身知识进行最终评审和测试,切勿直接盲从。
- 提示词定制:根据实际项目技术栈(如“React前端项目”、“Go微服务”),在核心提示词中嵌入特定框架或生态的检查规则(如React Hooks规则、Go并发模式)。