code-quality-enhancer

提供代码审查、BUG修复和编码最佳实践指导,帮助提升AI生成代码的质量。适用于代码质量评估、问题诊断和代码优化场景

SKILL.md

GitHub

代码质量提升技能

任务目标

  • 本 Skill 用于:提升AI生成代码的质量,包括代码审查、BUG修复和最佳实践指导
  • 能力包含:多维度代码审查、系统性BUG修复、编码最佳实践推荐、工具调用验证
  • 触发条件:用户要求"审查代码"、"修复BUG"、"提升代码质量"、"代码评审"或提供需要改进的代码时

前置准备

  • 无特殊依赖,充分利用智能体的代码理解和推理能力

操作步骤

标准流程

1. 代码审查

当用户需要代码审查时:

步骤1.1:读取并理解代码

  • 调用 read_file 读取目标代码文件
  • 识别编程语言、框架、技术栈
  • 理解代码的功能和上下文

步骤1.2:执行多维度审查 按以下维度检查代码质量:

  1. 功能正确性:逻辑是否正确,边界条件是否处理
  2. 代码风格:命名规范、缩进格式、注释完整性
  3. 性能效率:时间复杂度、空间复杂度、资源使用
  4. 安全性:SQL注入、XSS、认证授权、数据验证
  5. 可维护性:模块化、可读性、可扩展性

详细的检查点见 references/code-review-checklist.md

步骤1.3:生成审查报告

  • 列出发现的问题(按严重程度排序:严重/中等/轻微)
  • 为每个问题提供具体修复建议和代码示例
  • 标注符合最佳实践的优秀部分

2. BUG修复

当用户需要修复BUG时:

步骤2.1:定位问题

  • 读取错误信息、堆栈跟踪、相关代码
  • 使用 grep_file 搜索可能相关的代码段
  • 分析问题的触发条件和复现步骤

步骤2.2:分析根因

  • 追踪错误传播路径
  • 识别逻辑错误、数据异常、边界问题等
  • 区分表面问题和根本原因

详细的修复流程见 references/bug-fix-workflow.md

步骤2.3:生成修复方案

  • 提供完整的修复代码
  • 说明修复原理和影响范围
  • 考虑潜在的副作用和兼容性问题

步骤2.4:验证修复

  • 使用 exec_shell 执行测试命令(如果有测试脚本)
  • 检查修复后代码的语法正确性
  • 确认修复是否引入新的问题

3. 最佳实践指导

当用户需要编码最佳实践建议时:

  • 根据编程语言和框架查阅 references/best-practices.md
  • 识别代码中的反模式
  • 提供符合行业标准的改进建议
  • 推荐可用的工具和库

可选分支

  • 当涉及多个文件:使用 glob_file 查找相关文件,系统性审查代码库
  • 当需要运行验证:调用 exec_shell 执行 lint、单元测试或集成测试
  • 当代码不完整:先补充缺失的部分,再进行审查和修复

资源索引

领域参考

工具调用

  • read_file:读取源代码文件
  • grep_file:搜索代码模式和关键词
  • exec_shell:执行测试、lint、格式化工具
  • glob_file:查找相关文件

注意事项

  • 审查时要结合上下文,避免脱离实际的教条式评判
  • 修复BUG时要考虑影响范围,优先修复根本原因而非表面症状
  • 推荐最佳实践时要考虑项目实际情况,避免过度设计
  • 充分利用智能体的代码理解和推理能力,避免不必要的脚本调用
  • 保持输出简洁明了,突出问题本质和解决方案

使用示例

示例1:代码审查

用户:审查这个Python文件的质量
执行:
1. 读取代码文件
2. 按功能正确性、代码风格、性能、安全性、可维护性维度检查
3. 输出问题清单和修复建议

示例2:BUG修复

用户:这个函数有空指针异常,帮我修复
执行:
1. 定位异常发生的代码行
2. 分析变量初始化和边界条件
3. 生成添加空值检查的修复代码
4. 解释修复原理

示例3:最佳实践推荐

用户:这段代码有什么改进空间?
执行:
1. 识别代码中的反模式
2. 推荐符合Python风格的改进方案
3. 提供重写后的代码示例