跳到主要内容

StarShip CodeReviewer

简介

StarShip CodeReviwer是OpenCSG利用最新大语言模型技术倾情打造的代码审查助手，帮您在软件开发过程中降本增效，在审查合并请求（MR）过程中，帮您出谋献策，让您轻松应对复杂的代码变更。

StarShip CodeReviewer的功能​

StarShip CodeReviewer有三个重要功能，帮助您轻松应对代码审查：

  1. 审查MR

    StarShip CodeReviewer会仔细地审查MR，指出潜在的问题，并给出改进建议。详情请参阅审核功能文档。

  2. 总结MR

    StarShip CodeReviewer会简明扼要的总结MR，帮您快速了解MR，帮您搞懂代码变更的意图和来龙去脉。详情请参阅总结功能文档。

  3. 评价MR

    StarShip CodeReviewer用十大维度，几十种衡量指标来综合评价代码变更，确保代码满足最佳实践。此功能不仅给出综合评分，还会显示评分背后的原因。详情请参阅评价功能文档。

  4. 多语言代码静态分析

    StarShip CodeReviewer 集成了多种编程语言的linter工具，对MR代码进行深入扫描，确保代码在风格一致性、语法正确性和最佳实践方面都达到标准。同时，它还会提供针对性的改进建议，帮助提升代码质量。详情请参阅多语言代码静态分析功能文档。

为什么需要StarShip CodeReviewer？​

在茫茫代码浩海中，StarShip CodeReviewer可以助您一臂之力，引领您走向更安全、高效和优质的软件开发之路。

  1. 降低成本：尽可能少花时间进行人工代码审查。
  2. 提高质量：有见地的反馈和建议，让您的代码质量更上一层楼。
  3. 提高效率：通过简洁精确的总结描述迅速理解代码变更。
  4. 明智决策：用全面且可以解释的评分系统来衡量代码质量。

快速上手​

使用StarShip CodeReviewer​

有两种方式触发StarShip CodeReviewer:

  1. 自动出击：新的合并请求一旦创建并含有代码变更，StarShip CodeReviewer就会自动介入，开始审查，全程自动化，省心省力。

  2. 手动召唤：如果您想在特定时刻或对已提交的合并请求再次审查，可用手动方式触发。在MR里增加一条@codegpt开头的评论，StarShip CodeReviewer立刻出动。具体如何手动触发，请参阅手动触发指南。

支持的语言​

  1. 自动识别语言：如果您的MR标题或描述里含有中文，StarShip CodeReviewer自动切换到中文模式，让反馈更易懂。

  2. 默认英语：如果MR标题或描述里没有包括中文，将默认用英语输出。

请注意，对于部分本地部署的大语言模型，目前只能支持英语，因为根据实际测试显示，部分本地部署大模型处理中文的能力可能有待提升。