高效自动化办公代码审查优化提示词
这是一套面向技术团队与开发者的结构化提示词方案,旨在通过定义清晰的AI角色与任务,生成可直接...
提示词内容
复制角色定义与任务定位
请以“AI代码质量架构师”的身份进行思考与生成。你的核心目标是:设计一套结构化、可执行的提示词方案,用于驱动AI辅助工具(如ChatGPT、Claude、Cursor等)对代码进行自动化审查、分析与智能优化,从而将开发人员从重复的代码检查工作中解放出来,聚焦于核心业务逻辑与架构设计。
适用场景
- 在持续集成/持续部署(CI/CD)流水线中集成自动化代码审查环节。
- 开发者在提交代码(Pre-commit)前进行快速自查与优化。
- 技术负责人或架构师对新入职开发者代码进行标准化评审。
- 对遗留代码库进行批量分析、识别技术债务与潜在风险点。
- 为特定项目(如微服务、前端应用、数据管道)定制代码质量检查规则。
核心提示词
以下提示词可直接复制,填入具体代码文件或片段后使用:
- 基础审查指令:请扮演资深代码审查员。分析以下[编程语言]代码,严格检查其:1) 语法与潜在运行时错误;2) 代码风格与命名规范一致性(请参考[如:Google Style Guide]);3) 函数/方法的圈复杂度与单一职责原则遵守情况;4) 安全隐患(如SQL注入、硬编码凭证、不安全的反序列化)。请以表格形式列出问题、风险等级及具体行号。
- 性能优化指令:请扮演性能优化专家。审查以下代码,重点识别:1) 时间复杂度高的循环或嵌套查询;2) 内存泄漏风险(如未关闭的资源、大对象缓存);3) 数据库查询的N+1问题或缺失索引建议;4) 可进行缓存优化的重复计算。为每个问题提供重构代码示例。
- 结构化重构指令:请扮演重构顾问。针对以下代码模块,提出重构建议以实现:1) 更高的模块化与内聚性;2) 降低耦合度,便于单元测试;3) 应用明确的设计模式(如工厂、策略、观察者模式)以提升可扩展性。请输出重构前后的代码结构对比说明。
风格方向
- 输出结构化:强制要求AI以分级列表、表格、差分对比(Diff)或JSON格式输出结果,确保信息清晰、可机器解析。
- 语气专业化:提示词应引导AI使用客观、严谨的技术术语,避免模糊评价(如“代码不太好”),代之以具体指标(如“该函数圈复杂度为12,建议拆分为不超过3个子函数”)。
- 规则可配置:在提示词中预留“[ ]”占位符,方便用户插入项目特定的规则集、规范文档链接或阈值参数。
构图建议
- 逻辑流程图构图:当解释复杂代码逻辑或重构方案时,可提示AI生成Mermaid或PlantUML格式的流程图代码,可视化展示程序流程或模块依赖关系。
- 架构图示意:对于系统级优化,可提示AI用ASCII艺术或简短描述勾勒组件关系图,明确服务边界和数据流向。
细节强化
- 引入量化指标:在提示词中要求AI提供具体数值,如性能提升的百分比预估、复杂度降低的度量、重复代码行数统计。
- 链接权威参考:引导AI在给出建议时,引用官方语言文档、OWASP安全指南或知名架构原则(如SOLID、KISS)作为依据。
- 生成可执行代码片段:要求优化建议必须附带可直接复制粘贴的修正后代码片段、单元测试用例或配置脚本。
使用建议
- 将上述核心提示词保存为团队共享的模板,根据不同的审查重点(安全、性能、风格)灵活调用。
- 在CI环境中使用时,将AI输出结果格式化为注释自动提交到代码审查平台(如GitLab MR、GitHub PR),便于跟踪。
- 定期结合团队复盘,优化和更新提示词中的审查规则与阈值,使其更贴合项目演进和团队成长。
- 可将多次审查结果进行聚合分析,用于生成团队代码质量周报,可视化展示缺陷趋势与改进成果。