把「代码讲解」交给智能体,难点不在模型能力,而在流程是否说清楚:输入是什么(模块路径),按什么顺序处理,交付什么(分层讲解文档),哪些事不能做。Skill 就是把这些写下来的载体。

本文介绍如何在 Gemini CLI 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。

这个技能做什么

项目说明
技能代码讲解(code-explainer)
作用为新人逐层讲解一个模块:职责、数据流、关键函数
输入模块路径
输出分层讲解文档
形态纯提示词
风险低
适用人群开发者

处理流程分四步:

  1. 先给模块一句话职责
  2. 画出数据流
  3. 逐个讲关键函数
  4. 列出常见修改入口

这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;风险较低,但输出仍需快速过目再使用。

在 Gemini CLI 中是什么形态

Gemini CLI 会读取项目中的 GEMINI.md 作为长期上下文,还支持在 .gemini/commands/ 下用 TOML 文件定义自定义斜杠命令,把一段固定提示封装成一个命令。

项目级命令放在仓库的 .gemini/commands/,个人级放在用户目录下的 .gemini/commands/;命令中可用 {{args}} 接收调用时的参数。

示例配置

自定义命令示例(示意):

# .gemini/commands/code-explainer.toml
description = "代码讲解:为新人逐层讲解一个模块:职责、数据流、关键函数"
prompt = """
你现在执行「代码讲解」任务。
输入:{{args}}

按以下步骤处理:
1. 先给模块一句话职责
2. 画出数据流
3. 逐个讲关键函数
4. 列出常见修改入口

最后输出:分层讲解文档,并列出需要人工确认的内容。
"""

示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发者提出相关请求时能对上号;二是约束部分要写进「改动前确认有测试与版本控制,一次只改一类问题」这类领域规矩,避免智能体自作主张。

安装与启用步骤

  1. 在项目中新建 .gemini/commands/code-explainer.toml
  2. 填写 description 与 prompt,prompt 中写清步骤与输出
  3. 在 GEMINI.md 中补充项目约定,供命令执行时参考
  4. 在 CLI 中输入 /code-explainer 加参数调用
  5. 提交到仓库,团队共享

实操:一次完整的运行

假设你在代码仓库与终端中发出这样的请求(虚构示例):

帮我做一下代码讲解,材料是附上的模块路径。

智能体识别到任务与「代码讲解」相关后,会依次先给模块一句话职责、画出数据流、逐个讲关键函数、列出常见修改入口。最终交付分层讲解文档,并在末尾列出需要人工确认的内容。你的工作是对照原始模块路径抽查两三处关键信息,确认无误后再使用。

测试与验收

用空参数、正常参数和超长参数各调用一次命令,确认提示中的步骤与约束都生效。

针对这个技能,还建议额外准备:

  • 一份信息齐全的标准模块路径,检查输出是否完整
  • 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
  • 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效

常见坑

  • 把所有流程都塞进 GEMINI.md,导致每次对话上下文过长。
  • 命令名与内置命令或其他命令重名,调用时混淆。
  • 只写了步骤,没写交付格式,导致每次输出的分层讲解文档结构不同。
  • 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。

延伸阅读

说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。