dsh-doxygen
在终端中运行以下命令:
dsh plugin install FantastyQAQ/dsh-doxygen
将以下提示词粘贴到 DeepSeek Harness 对话框中:
在 DeepSeek Harness 终端执行 dsh plugin install FantastyQAQ/dsh-doxygen(需带 --profile,如 desktop),也可从 https://github.com/FantastyQAQ/dsh-doxygen 获取源码后按 README 安装。
插件介绍
C/C++ 项目里 Doxygen 注释常常跟不上代码:函数签名变了,块注释仍描述旧行为;手工补 @param、@return 也容易漏项。dsh-doxygen(技能名 doxygen-comment)不是片段收藏夹,而是给 AI 助手用的端到端流水线:读取函数签名、生成或补全注释,并在签名变化时把注释标为过期,便于按仓库小范围维护。
核心围绕定位、生成与扫描。parse_function.py 用 tree-sitter 只读解析 C/C++(含 Qt signals/slots),按行号或函数名输出 JSON;gen_doxygen.py 提供六类模板,默认只打印 diff,确认后 --write 写回并保留原换行与编码。--scan 用签名指纹区分 missing、partial、stale、ok,避免一次性改上百个文件。
注册时会探测 Python 3.10+ 与 tree-sitter,环境不可用会要求助手停止并转告安装步骤,而不是把解释器错误误当成找不到函数。已有 Doxygen 块只补不重写,指纹行由脚本维护,输出强制 UTF-8,对中文与 Windows 控制台更友好。
适合长期维护注释质量的 C/C++、Qt 团队,以及希望 Agent 先 scan、看 diff、再分批改动的开发者;任何具备 Bash 与文件读写能力的宿主均可使用。
使用场景
- 新函数或改签名后需要快速生成或补全 Doxygen 块
- 准备发版前想扫描全仓库,找出缺失或过期的注释
- 让 AI 助手按 diff 预览、小批量刷新注释而不是整库重写
适合人员
- 维护 C/C++ 或 Qt 工程并重视 API 文档的团队
- 习惯用 Agent 驱动脚本、先 scan 再改动的开发者
- 需要在多编码与 Windows 环境下稳定生成 UTF-8 注释的维护者