workbuddy 提供四种高效注释生成方式:一、快捷键 ctrl+alt+c/cmd+option+c 激活智能注释;二、用 // @workbuddy: 指令加 ctrl+enter 触发定制化注释;三、批量选中函数后右键选择 batch annotate 统一生成;四、自定义模板并绑定快捷键快速套用。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您在使用 WorkBuddy 编写代码时希望快速生成规范、准确的注释,但尚未掌握其内置的快捷键与 AI 指令组合方式,则可能是由于未触发智能注释识别机制或指令格式不匹配。以下是实现高效注释生成的具体操作路径:
一、调用智能注释快捷键
WorkBuddy 支持通过预设快捷键一键激活上下文感知注释生成功能,该功能会自动分析光标所在函数、类或代码块的结构与逻辑,生成符合语言惯例的注释模板。
1、将光标置于待注释的函数定义行首(如 def process_data(): 或 public void calculate() {})。
2、按下 Ctrl + Alt + C(Windows/Linux)或 Cmd + Option + C(macOS)。
3、等待右下角状态栏显示“注释生成中…”提示,约1–2秒后,注释将自动插入至函数上方。
二、使用自然语言AI指令注入注释
当标准快捷键无法覆盖特殊场景(如需强调副作用、标注待优化点或补充业务语义),可通过内联指令方式直接向 WorkBuddy 的 AI 引擎传递明确意图,绕过默认解析逻辑。
1、在目标代码行下方空行处输入 // @workbuddy: 为该函数添加中文注释,说明其处理用户登录失败重试的逻辑。
2、按下 Enter 键确认指令行。
3、立即按 Ctrl + Enter(Windows/Linux)或 Cmd + Enter(macOS)执行指令。
三、批量为多个函数生成统一风格注释
针对已选中的多个函数体,WorkBuddy 允许一次性应用相同注释策略,避免逐个触发,适用于重构阶段的文档补全。
WorkBuddy 桌宠工厂 —— 给一张角色图、一个 codex.pet 链接、一条 codex-pets.net 下载 URL、或一份现成的精灵表,就能自动创建一只可联动 WorkBuddy 状态的桌面宠物。当用户说"创建桌宠"、"做一只桌宠"、"用这张图做桌宠"、"从 codex.pet 安装桌宠"、"导入 codex 桌宠 XX"、"装一下 codex-pets.net 上的 XX&quo
1、按住 Shift 键并用鼠标拖选多个函数定义及其主体(确保每段选区以 def / function / public 等关键字起始)。
2、右键弹出菜单,选择 WorkBuddy → Batch Annotate。
3、在弹出的轻量面板中勾选 “使用 JSDoc 风格” 和 “包含参数类型推断” 两项。
4、点击 Apply 按钮,注释将按顺序插入各函数顶部。
四、自定义注释模板并绑定快捷键
WorkBuddy 允许用户预置常用注释结构(如含作者、版本、审核人字段的内部规范),并通过快捷键快速套用,无需每次修改指令内容。
1、进入 Settings → WorkBuddy → Annotation Templates。
2、点击 + Add Template,输入名称为 “Internal Python Docstring”。
3、在模板内容框中粘贴以下结构:
"""
{summary}
:param {params}:
:return: {returns}
:author: ${user.name}
:version: ${file.version}
"""
4、返回快捷键设置页,搜索 “Insert Internal Python Docstring”,将其绑定至 Ctrl + Shift + D。










