跳到主要内容

触发代码审查

手动触发

除了创建MR时候,自动触发外,如果您想手触发StarShip CodeReviewer,可以通过在您的合并请求(MR)中添加特定的评论来触发。

  • 触发MR审查:

    在合并请求(MR)中添加如下评论,触发一个自动化的代码审查过程,分析代码变更,发现潜在的错误以及改进方案。

    @codegpt /review
  • 触发MR总结:

    在合并请求(MR)中添加评论如下评论,这个命令启动一个自动化总结过程,帮助审查者快速理解MR。

    @codegpt /describe
  • 触发MR评估:

    在合并请求(MR)中添加评论如下评论,触发对代码进行全面评估。这包括性能分析、安全漏洞检查和优化建议,确保代码变更既健壮又高效。

    @codegpt /evaluate
  • 触发MR全面审查:

    如果您希望进行全方位分析,包括审查、描述和评估您的代码,只需在合并请求(MR)中添加评论如下评论。这个命令整合了前面命令的所有功能,一次性地对您的代码进行彻底的检查和评估。

    @codegpt /all
  • 访问帮助信息:

    想要获得帮助或更多关于可用命令及其使用方法的信息,请在合并请求(MR)中添加评论如下评论。

    @codegpt /help

在MR中触发这些功能,可以极大地简化代码审查过程,提高代码质量。

使用自定义配置的大型语言模型 (LLM)

StarShip CodeReviewer旨在提供多样化和全面的代码审查体验,支持与 SaaS(软件即服务)大型语言模型(如 GPT-4),同时也支持自定义本地 LLM 服务(例如deepseek-code-33B)。研发团队可以从数据隐私等方面考虑,选择最适合特定代码审查需求的 LLM 服务。

如果您已设置了一个自定义 LLM,您可以通过在您的合并请求(MR)中添加格式为 @codegpt-custom ...的评论来触发。

例如,如果您配置了一个更好地适应项目特定要求或编码标准的自定义本地 LLM,只需使用如下命令来触发它:

@codegpt-custom /review

这个命令将使用您的自定义配置的 LLM 启动代码审查过程,提供独特的见解和建议。

在默认和自定义 LLM 之间切换

如果您将自定义本地 LLM 设置为默认模型,但偶尔需要利用另一个模型(如 GPT-4),StarShip CodeReviewer支持轻松地为特定任务切换。在MR中在评论中添加 @codegpt-gpt4 ...,这使得StarShip CodeReviewer暂时利用 GPT-4 模型完成审查。

例如,如果您希望使用 GPT-4 模型进行代码审查,您将输入:

@codegpt-gpt4 /review

请注意,一些信息(如帮助信息)可能也会依然显示codegpt