Agent Skills
返回列表
代码审查工具

代码审查工具

开发编程 更新于 2026.08.30

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_6cc7d052/code-reviewer。

技能介绍

解决代码审查中的手动与主观性问题

代码审查是保证软件质量的关键环节,但传统方式依赖开发者逐行阅读,容易因疲劳或经验差异而遗漏关键问题,尤其是跨项目或团队协作时,对规范的一致性检查效率低下。

本技能通过自动化静态分析来解决这些问题。它提供了一套完整的审查流程,核心在于将代码问题的发现与规范评分标准化。

核心能力与关键步骤

工具的工作流程清晰,分为两步:

  1. 执行代码分析:调用 scripts/code_reviewer.py 脚本。它会自动识别目标文件夹内代码的语言类型(如 PythonJavaJavaScript),并执行多维度检测:

代码规范性检查:遵循通用最佳实践。
潜在Bug与性能问题识别:基于静态分析模式。
注释覆盖率统计:量化文档完整度。
华为Java编程规范评分:对Java文件进行专项评估,从排版、注释、命名、编码规范到性能可靠性进行100分制打分。
此步骤输出一个结构化的 review_results.json 文件。

  1. 生成可读报告:调用 scripts/report_generator.py,将JSON数据转换为易于阅读的Markdown报告(code_review_report.md)。报告包含:概览统计、华为规范评分详情、按严重性分级的问题列表、以及文件级的深度分析。关键输出是可直接定位到代码行的具体建议。

适用边界与注意事项

尽管自动化提供了巨大便利,但必须理解其局限性:

  • 工具基于静态分析,无法检测运行时状态、复杂业务逻辑错误或并发竞争条件。
  • 华为Java编程规范评分功能仅适用于Java文件,其他语言文件仅参与基础的质量检查,不生成规范评分。
  • 审查结果应视为质量保障的第一道关卡,建议后续结合单元测试、集成测试及人工Code Review以形成闭环。
  • 不同编程语言的检查规则可能存在差异,详细规则定义可参考技能包内的 references/review-guidelines.md 文档。报告中的“严重”问题应优先修复。

使用场景

  • 在Java企业项目代码合入主干前,需要扫描整个文件夹,检测不符合华为编程规范的条目并生成评分报告,以供技术评审会议快速定位修改点。
  • 维护一个多语言微服务项目,希望定期运行工具检查所有服务的代码规范性和潜在性能问题,生成结构化报告指导重构优先级。
  • 作为代码审查员,收到大量PR提交,需要快速评估每个PR相关文件的代码质量,使用工具生成报告来辅助发现严重问题和优化建议。
  • 在开发Python库时,想量化注释覆盖率和命名规范性,以便在发布前确保代码可读性和可维护性达到团队标准。

适合人员

  • 负责Java后端开发的工程师,需要在提交代码前自动检测是否符合华为内部编码规范,以减少审查反馈次数。
  • 开源项目的核心维护者,需要高效审查来自社区贡献者的代码,快速识别潜在bug和规范问题以保持项目质量。
  • 技术团队的架构师,希望工具能提供多维度的代码质量评估数据,用于制定团队编码指南和培训计划。
  • 持续集成流程的DevOps工程师,需要将代码审查脚本集成到CI流水线中,实现自动化质量门禁。