AB
AiBoss
チュートリアル

代码小浣熊

チュートリアル

用代码小浣熊在 VS Code 与 IntelliJ IDEA 中完成代码补全与注释生成

代码小浣熊是商汤科技推出的基于大语言模型的智能编程助手,支持 30 多种主流编程语言,并兼容 VS Code、IntelliJ IDEA 等 IDE。本文说明如何安装插件、通过侧边栏、编辑器内窗口与终端三种方式调用助手,并用注释生成代码、补全代码与生成文档,附完整示例与使用限制。

代码小浣熊(Raccoon)是商汤科技推出的智能编程助手,底层基于大语言模型。它面向日常写代码、读代码、补文档这几类高频工作:支持 30 多种主流编程语言(Python、Java、JavaScript、C++、Go、SQL 等),兼容 VS Code、IntelliJ IDEA 等主流集成开发环境,能力覆盖从需求分析、架构设计、代码编写到软件测试的开发流程。如果你希望在不离开编辑器的前提下获得代码补全、自然语言问答、注释生成代码、跨语言翻译、单元测试生成与代码重构等帮助,可以按本文步骤把它接进自己的工作流。站内也收录了这款工具,可参见 代码小浣熊。

需要先说明一点:本文整理的是工具的功能结构与调用方式,不涉及任何个人使用体验的描述。文中提到的功能范围、语言数量、IDE 兼容情况等,均以产品官网当前展示的信息为准;价格、配额、可用地区等易变信息请以官网为准。

准备工作

在开始之前,需要把下面几件事确认清楚。代码小浣熊是插件形态的助手,主体能力运行在 IDE 内,因此前置条件主要集中在账号与编辑器两端。

账号与登录

  • 需要一个可用的代码小浣熊账号。插件安装完成后通常需要在 IDE 内完成登录或授权,才能调用模型能力。
  • 账号的可用范围、免费额度、订阅方案与计费方式属于易变信息,请以官网当前页面为准,不要依据旧文章里的数字做规划。
  • 如果团队统一采购,建议先确认账号归属与成员管理方式,再批量分发插件。

编辑器与插件

  • 确认你使用的 IDE 在支持列表内。素材明确提到的是 VS Code 与 IntelliJ IDEA 两类,其余 IDE 是否支持请以官网为准。
  • 在对应 IDE 的插件市场里搜索代码小浣熊(Raccoon)并安装。VS Code 走 VS Code 扩展市场,IntelliJ IDEA 走 JetBrains 插件市场。
  • 安装完成后重启 IDE,确保插件加载成功、侧边栏出现 Raccoon 图标。

项目侧的准备

  • 准备一个可以正常打开、能编译或能运行的项目。助手需要读取上下文,项目结构越完整,生成的建议越贴近实际。
  • 确认项目里没有把密钥、口令等敏感信息硬编码在会被读取的文件中。向助手提问时也不要粘贴真实凭据。
  • 如果项目使用私有依赖或内网仓库,先确认网络环境允许插件正常访问其服务端。

操作步骤

代码小浣熊在 IDE 内提供三种调用入口:侧边栏内的代码助手(图形界面)、编辑器内的代码助手(图形界面,可开多个实例)、终端面板里的代码助手(命令行)。三者共用同一套账号与模型能力,区别在于使用场景与交互形态。下面按「安装 → 选择入口 → 使用具体功能」的顺序展开。

第一步:安装并激活插件

  1. 打开你的 IDE,进入插件市场。
  2. 搜索「代码小浣熊」或「Raccoon」,找到官方插件条目。
  3. 点击安装,等待下载与解压完成。
  4. 重启 IDE。
  5. 在侧边栏找到 Raccoon 图标,点击后按提示完成登录或授权。

登录成功后,侧边栏即为代码助手的主界面。后续所有功能都从这里或编辑器内触发。

第二步:选择一种调用方式

方式一:侧边栏内代码助手(GUI)

点击 VS Code 侧边栏的 Raccoon 图标即可激活代码助手。这是最基础的入口,提供图形化界面,适合提问、贴代码片段、让助手解释或改写。日常的「这段代码什么意思」「帮我写个函数」这类需求,用这个入口最直接。

方式二:编辑器内代码助手(GUI,多实例)

在 Raccoon 侧边栏视图中,点击标题栏上的新窗口图标,可以创建一个新的助手实例。这样做的价值在于并行:一个实例用来问当前文件的实现细节,另一个实例用来讨论另一个模块的设计,互不打断。多线开发时,把不同任务的对话分开,上下文不容易串。

方式三:终端面板代码助手(CLI)

在 Raccoon 侧边栏视图中,点击标题栏上的「更多…」,选择「新建 Raccoon 终端」,即可创建一个独立的终端实例,并且可以创建多个。终端形态适合需要结合命令行操作的场景,例如在构建、测试、脚本执行的过程中随时提问,而不必切回图形界面。

三种方式可以同时使用。建议按任务类型分工:写代码时用编辑器内实例,查资料与讨论设计时用侧边栏,跑命令与排查环境问题时用终端。

第三步:用注释生成代码

这是代码小浣熊最常用的能力之一:先写注释描述意图,再由助手生成对应实现。操作上分两步——在目标位置写好注释,然后触发助手。

# 读取指定目录下的所有 .log 文件,按修改时间倒序排列,
# 返回文件名与大小的列表,跳过空文件

把上面这段注释写在 Python 文件里,选中它,通过侧边栏或编辑器内的助手入口发起请求,助手会依据注释与当前文件的上下文生成实现。生成结果需要人工检查:注释写得越具体(输入、输出、边界条件),生成结果越接近可用。

同样的做法适用于 Java、JavaScript、C++、Go、SQL 等语言。注释语言本身不限定,用中文或英文描述都可以,关键是描述清楚约束。

第四步:使用代码补全

代码补全由编辑器内的自动或手动触发完成。触发后,编辑器状态栏会指示当前请求的状态,你可以据此判断请求是在进行中、已完成还是失败。

  • 自动触发:正常输入代码时,助手根据上下文给出补全建议,按提示接受即可。
  • 手动触发:在需要补全的位置主动发起请求,适合自动触发没有给出理想结果的场合。
  • 状态栏:留意状态栏的指示,避免在请求未完成时重复触发,造成等待。

补全质量与上下文强相关。把相关文件在编辑器里打开、把光标放在语义明确的位置,通常比在空白文件里触发更有效。

第五步:用自然语言对话完成开发任务

开放对话功能允许用自然语言描述需求,助手给出编程建议与解决方案。适合的任务包括:

  • 解释一段不熟悉的代码或报错信息;
  • 把一段实现翻译成另一种编程语言(跨编程语言翻译);
  • 为已有函数生成单元测试用例;
  • 对代码做修正与重构;
  • 技术领域知识问答。

提问时把上下文一并给出会明显提升结果可用性:贴出相关函数、说明运行环境与版本、指出期望的输入输出。只给一句「帮我优化一下」通常得不到可落地的结果。

第六步:生成需求文档与技术文档

代码小浣熊支持按需求自动生成需求文档、代码注释、代码解释文档与技术文档。典型用法是:选中一段代码或一个模块,说明要生成的文档类型与面向的读者,由助手产出初稿,再由人补充业务背景与边界说明。

这一步的产出建议纳入版本管理,与代码一起评审。自动生成的文档容易漏掉隐含约定,评审环节不能省。

一个完整示例

下面用一个最小但完整的流程,把安装、调用、生成、验证串起来。示例使用 VS Code 与 Python,其他语言与 IDE 的操作路径一致。

场景

项目里有一个日志目录,需要写一个函数:扫描目录下的 .log 文件,按修改时间倒序返回文件名与大小,跳过空文件。

步骤 1:安装与登录

  1. 打开 VS Code,进入扩展市场,搜索代码小浣熊(Raccoon),安装官方插件。
  2. 重启 VS Code。
  3. 点击侧边栏的 Raccoon 图标,按提示登录账号。

步骤 2:写注释描述需求

新建 log_scan.py,写入注释:

# 扫描指定目录下的所有 .log 文件
# 按文件修改时间倒序排列
# 返回 [(文件名, 字节大小), ...]
# 跳过大小为 0 的空文件
# 目录不存在时抛出 FileNotFoundError

步骤 3:触发助手生成实现

选中这段注释,通过侧边栏的代码助手发起请求,或在编辑器内新建一个助手实例后发起请求。助手会基于注释与当前文件上下文生成函数体。生成结果大致会包含目录遍历、文件过滤、排序与异常处理几个部分。

步骤 4:人工检查与补全

生成后逐条对照注释检查:

  • 是否只收集 .log 后缀的文件;
  • 排序方向是否为倒序;
  • 是否跳过了大小为 0 的文件;
  • 目录不存在时是否抛出 FileNotFoundError;
  • 返回值结构是否为「文件名 + 字节大小」的列表。

发现遗漏就在原位置继续对话修正,不必重新生成整段。修正完成后,把光标移到函数内部,用代码补全补齐剩余细节,并留意编辑器状态栏的请求状态。

步骤 5:生成单元测试

选中写好的函数,向助手提出「为这个函数生成单元测试,覆盖空目录、目录不存在、全部为空文件、正常多文件四种情况」。助手会给出测试用例初稿。检查断言是否真正覆盖了上述分支,再运行测试确认通过。

步骤 6:生成文档

最后让助手基于函数生成一段说明文档,写清参数、返回值与异常。把文档与代码一起提交,后续维护时以代码为准同步更新。

整个流程走完,你会得到一个可运行、有测试、有文档的函数。这套「注释 → 生成 → 检查 → 测试 → 文档」的循环,可以复用到任何语言与任何模块。

注意事项

下面这些限制与坑点来自工具本身的功能设定,使用前值得先了解。

语言与 IDE 支持范围

代码小浣熊支持 30 多种主流编程语言,并兼容 VS Code、IntelliJ IDEA 等主流 IDE。但「主流」不等于「全部」:如果你使用的是小众语言或非主流编辑器,先确认是否在支持范围内,再决定是否投入工作流。具体支持清单以官网当前信息为准。

生成结果必须人工复核

助手生成的是建议,不是保证正确的代码。注释生成代码、代码补全、重构建议、单元测试都存在出错的可能,尤其是边界条件与异常分支。任何进入生产环境的代码都应经过评审与测试。

上下文决定质量

助手依据上下文生成内容。相关文件没有打开、光标位置语义模糊、注释描述笼统,都会让结果偏离预期。提问时把环境、版本、输入输出、约束条件写清楚,比反复重试更有效。

敏感信息不要外传

对话与生成过程会把代码片段发送到服务端。项目中的密钥、口令、个人数据、未公开的业务逻辑,不要粘贴进对话窗口,也不要在会被读取的文件里硬编码。涉及合规要求的项目,先确认数据处理的边界再使用。

状态栏与请求节奏

代码补全会通过编辑器状态栏指示当前请求状态。请求进行中时重复触发不会加快结果,反而可能造成排队。看到状态未完成时,稍等再操作。

多实例要分清用途

编辑器内可以创建多个助手实例,终端也可以创建多个独立实例。实例多了容易把不同任务的上下文混在一起。建议按任务或模块划分实例,任务结束后及时清理不再需要的对话。

价格与配额以官网为准

账号的免费额度、订阅方案、计费方式、可用地区都属于会变化的信息。本文不给出具体数字,使用前请到官网核对当前政策,避免按旧信息做预算。

文档生成需要业务补充

自动生成的需求文档与技术文档能覆盖结构性的内容,但业务背景、隐含约定、历史决策原因通常不在代码里,需要人工补写。把自动生成的文档直接当作最终交付物,容易在评审时暴露缺口。