自动化办公代码审查优化专业版提示词
这是一套面向自动化办公场景的代码审查与优化专业提示词方案,旨在帮助开发者或技术管理者系统性...
提示词内容
复制角色定义与任务定位
请以“自动化办公流程架构师”与“代码质量分析师”的双重身份,运用本提示词方案。您的核心目标是:设计并生成一套高度结构化、可嵌入自动化工作流的代码审查与优化分析报告,将枯燥的代码检查转化为清晰、直观、可执行的视觉化或文本化输出,从而系统性提升团队开发效率与代码质量。
适用场景
- 为CI/CD流水线自动生成代码审查摘要与可视化报告。
- 在团队知识库或周报中,自动化生成代码质量趋势分析与优化热点图。
- 为新项目或遗留系统快速生成代码健康度评估与重构优先级建议。
- 制作面向非技术决策者的、易于理解的代码质量与风险演示材料。
核心提示词
以下提示词可直接复制,用于引导AI生成具体内容:
- “作为代码质量分析师,请对[编程语言,如Python/Java]代码仓库[可指定分支或路径]进行自动化审查。重点分析:1. 代码重复率;2. 圈复杂度超过10的函数;3. 违反[如PEP 8、Google Style]编码规范的条目。请以表格形式列出前10个最需优化的函数及其具体问题与修改建议。”
- “生成一份本周代码提交质量报告。包含:提交数量统计、引入的Bug风险等级分布(高/中/低)、代码注释覆盖率变化趋势。要求使用对比色块和趋势折线图进行可视化描述。”
- “针对[具体功能模块,如用户认证模块]的代码,提出三条具体的性能优化建议与两条可读性重构建议。每条建议需包含:现状代码片段示例、优化后代码示例、预期收益(如执行时间减少X%、内存占用降低Y%)。”
风格方向
- 报告风格:专业、严谨、结构化。采用分点、分级标题、表格、数据高亮等方式组织信息,避免冗长段落。
- 视觉基调(若生成图表描述):采用科技蓝与中性灰作为主色调,搭配警示性的橙色或代表通过的绿色作为数据点缀色,营造专业、理性的数据分析氛围。
- 语言风格:客观、精准、指向明确。使用“检测到”、“建议修改为”、“预期提升”等行动导向的词汇。
构图建议
- 若生成可视化报告描述,建议采用“仪表盘”式布局:核心KPI(如代码健康度得分)置于顶部醒目位置,中部为趋势图表区(如复杂度变化折线图),底部为详细问题清单。
- 对于问题列表,采用“文件名/函数名:具体问题描述 -> 优化建议”的左右或上下对照式结构,确保问题与解决方案紧密关联。
- 使用图标化引导:如用“⚠️”表示警告,用“✅”表示已通过检查,用“????”表示趋势增长,增强可读性。
细节强化
- 数据具体化:避免“某些函数”、“性能较差”等模糊表述。强制要求输出具体数值(如“函数calculate()的圈复杂度为15,建议拆分为3个子函数”)、具体行号、具体规范条款。
- 优先级标注:对发现的问题或给出的建议,必须标注优先级(P0/P1/P2)或解决紧急度(高/中/低),并提供排序依据。
- 可操作性:每一条优化建议都应尽可能附带简明的代码示例或修改步骤,确保开发者能够直接参照实施。
- 扩展词注入:在提示词中可加入以下词汇以丰富内容维度:静态分析(SAST)、技术债务量化、内存泄漏模式、依赖项安全漏洞(CVE)、测试覆盖率缺口。
使用建议
- 将“核心提示词”部分的内容,替换其中的方括号变量为您的实际项目信息,即可作为基础提示词直接使用。
- 为获得更精准的结果,建议在提示词开头明确指定输出格式,例如:“请以Markdown格式输出,并包含二级标题与表格”。
- 本方案提示词可与自动化脚本结合,定期从版本控制系统拉取最新代码并触发审查任务,实现真正的“自动化办公”。
- 对于复杂项目,建议采用“分模块审查、再汇总报告”的策略,将大型任务拆解后依次使用本提示词,最后整合成总览报告。