SKILL HUB › 免费提示词 › 编程与开发 › 代码审查

代码审查

🆓 免费编程与开发

代码审查(免费)。对代码进行评审:适用于代码合并前的 Review、质量把关、技术复盘场景,解决「Review 流于形式、问题看不全、意见没说服力」的问题。用户只需提供相关信息,AI 即按内置提示词模板输出完整结果。

代码审查(免费)

技能概述

对代码进行评审:适用于代码合并前的 Review、质量把关、技术复盘场景,解决「Review 流于形式、问题看不全、意见没说服力」的问题。最终目的:产出可直接套用的代码审查提示词:用户只需粘贴代码与上下文,AI 即输出分级、可执行的评审意见。本技能内置可直接套用的提示词模板,加载后 AI 按模板工作,无需额外配置。

适用场景

  • 对代码进行评审:适用于代码合并前的 Review、质量把关、技术复盘场景,解决「Review 流于形式、问题看不全、意见没说服力」的问题
  • 典型目的:产出可直接套用的代码审查提示词:用户只需粘贴代码与上下文,AI 即输出分级、可执行的评审意见

调用方式

当用户提出以下类型的需求时,激活本技能:

  • "请帮我代码审查"
  • "用代码审查的方法处理这个内容"
  • "按代码审查模板生成"

激活后,按下方【内置提示词模板】执行:将用户提供的信息填入模板占位处(____),直接输出完整结果;用户未提供的信息保持占位并提示其补充。

内置提示词模板

【角色设定】
你是资深代码审查工程师,擅长找出代码中的问题并给出可落地的修改建议。

【任务】
根据我的代码,帮我做一次代码审查。

【我会提供的信息】
1. 代码片段(粘贴):____
2. 编程语言与框架:____
3. 代码功能(这段代码做什么):____
4. 已知的约束(性能/兼容性/安全要求):____
5. 审查重点(逻辑/安全/性能/可读性,可不填):____

【审查要求】
1. 按严重程度分级输出:严重(会导致 Bug/安全问题)/一般(影响质量)/建议(优化项)。
2. 每个问题给:位置(行号或函数)、问题描述(为什么是问题)、修改建议(具体怎么改)、示例代码(如适用)。
3. 覆盖四类检查:逻辑正确性、边界与异常处理、安全风险(注入/XSS/越权等)、性能与可读性。
4. 对整体代码给 1 句总评(可合并/需修改/重写)。
5. 不重写全部代码,聚焦问题点。

【输出格式】
一、审查总结(总评+问题数量)
二、问题清单(分级表格:位置/问题/建议)
三、修改示例(2-3 处关键)
四、良好实践建议(2 条)

请直接输出,不要询问多余信息;代码缺失处用「____」占位。

输出要求

  • 严格按模板指定的输出格式分节输出,不省略、不额外发挥。
  • 内容真实合规:不编造数据,不确定处标注「需核实」;涉及专业领域以专业来源为准。
  • 输出可直接复制使用,缺失信息用 ____ 占位并提示用户补充。

注意事项

  • 本技能为免费技能,无支付环节。
  • 如需该场景的高阶版提示词与更多玩法,可在本技能基础上要求 AI 深化;高阶版含五步工作流与合规自检。

风险提示

  • 本工具输出结果仅供参考,不构成专业意见或收益承诺;重要决策请自行核实并判断。
  • 免费工具不提供持续服务保证,具体以 SKILLHub 平台规则为准。

🚀 高阶用法与进阶技巧

1. 自定义提示词模板

高级用法: 用户可以根据自己的需求自定义提示词模板。例如,在模板中增加对特定技术栈的检查项,或者调整问题的严重程度分级标准。

参数/步骤:

  1. 打开内置提示词模板。
  2. 根据需要修改或添加新的占位符和要求。
  3. 保存并使用自定义模板进行代码审查。

2. 多语言支持

高级用法: 对于多语言的代码审查,用户可以指定多种编程语言,并在提示词中明确指出。

参数/步骤:

  1. 在提示词模板中的“编程语言与框架”部分,填写多个语言或框架。
  2. 确保AI能够识别并处理这些不同语言的代码片段。
  3. 提交代码审查请求时,AI将根据指定的语言进行相应的检查和反馈。

3. 定制化审查重点

高级用法: 用户可以根据项目的具体需求,定制化审查的重点。例如,对于一个安全性要求较高的项目,可以将安全风险作为主要的审查重点。

参数/步骤:

  1. 在提示词模板中的“审查重点”部分,填写具体的检查项(如逻辑、安全、性能、可读性)。
  2. 确保AI在输出问题清单时,优先关注这些定制化的重点。
  3. 提交代码审查请求时,AI将根据指定的审查重点进行检查和反馈。

4. 集成自动化工具

高级用法: 用户可以将该技能集成到现有的开发流程中,通过自动化工具(如CI/CD)调用代码审查功能,实现自动化的代码质量检测。

参数/步骤:

  1. 在CI/CD配置文件中添加调用代码审查技能的脚本。
  2. 确保脚本能够获取必要的代码片段和上下文信息,并将其传递给AI进行审查。
  3. 集成后的自动化工具将定期或在特定事件(如代码提交)时触发代码审查,输出结果并集成到开发流程中。

📋 实战案例(3个真实场景)

案例1:Web应用安全性审查

场景描述: 一个在线电商平台的前端开发团队需要对新上线的购物车功能进行代码审查,以确保其安全性和性能。

输入示例:

// 购物车添加商品的函数
function addToCart(productId, quantity) {
    // 获取用户信息和购物车数据
    const user = getUserInfo();
    const cart = getCartData(user.id);

    // 检查库存是否足够
    if (checkStock(productId, quantity)) {
        // 更新购物车数据
        updateCart(cart, productId, quantity);
        return true;
    }
    return false;
}

输出要点:

  • 位置: 第6行
  • 问题描述: 未对用户输入的productId和quantity进行验证,可能导致SQL注入或越权访问。
  • 修改建议: 对输入参数进行严格验证,并使用预编译语句来防止SQL注入。

案例2:移动应用性能优化

场景描述: 一个移动游戏开发团队需要对新上线的关卡逻辑进行代码审查,以确保其性能和稳定性。

输入示例:

// 游戏关卡逻辑函数
public void levelLogic(int[] obstacles, int playerPosition) {
    for (int obstacle : obstacles) {
        if (playerPosition == obstacle) {
            // 玩家遇到障碍物,游戏结束
            endGame();
        }
    }
}

输出要点:

  • 位置: 第4行
  • 问题描述: 使用for-each循环遍历obstacles数组,可能导致性能瓶颈。
  • 修改建议: 使用二分查找算法来优化障碍物检测的效率。

案例3:后端API安全审计

场景描述: 一个金融应用的后端开发团队需要对新上线的用户认证API进行代码审查,以确保其安全性。

输入示例:

# 用户认证函数
def authenticateUser(username, password):
    user = getUserByUsername(username)
    if user and user.password == password:
        return True
    return False

输出要点:

  • 位置: 第4行
  • 问题描述: 直接比较明文密码,可能导致密码泄露。
  • 修改建议: 使用哈希算法对用户输入的密码进行加密,并与数据库中存储的哈希值进行比对。

💰 价值对比(为什么这个工具值得用)

1. 减少人工审查时间

优势: 该技能可以自动化代码审查过程,显著减少人工审查所需的时间和精力。通过AI生成的详细评审意见,开发者可以直接应用建议,提高开发效率。

2. 提高代码质量

优势: 该技能能够识别出代码中的潜在问题,并提供具体的修改建议。通过系统化的检查和反馈,可以有效提升代码的质量和稳定性,减少bug的发生率。

3. 降低风险

优势: 对于安全性要求较高的项目,该技能可以识别并指出代码中的安全漏洞,如SQL注入、XSS攻击等。通过提前发现并修复这些问题,可以有效降低项目的安全风险。

🎯 使用场景与适用人群

使用场景

  • 代码合并前的Review: 在代码合并到主分支之前,进行详细的代码审查。
  • 质量把关: 对新开发的功能或模块进行质量检测,确保其符合项目标准。
  • 技术复盘: 对已上线的代码进行复盘,发现潜在问题并提出优化建议。

适用人群

  • 开发者: 无论是前端、后端还是移动应用开发者,都可以使用该技能来提升代码审查的质量和效率。
  • 项目经理: 可以将该技能集成到项目的开发流程中,确保代码质量符合项目要求。
  • 安全专家: 对于安全性要求较高的项目,可以利用该技能进行代码安全审计,发现潜在的安全漏洞。

相关推荐

分类:编程与开发  ·  适合人群:开发者/创业者/企业IT  ·  预期效果:提升开发效率/降低技术门槛  ·  标签:—