用途:为所有未提交的代码改动更新内联文档,适用于修改代码后或文档需要同步的场景。
主要能力与步骤:先运行 git diff --name-only 找出被修改的文件;对每个代码文件,检测其现有文档风格(参考 references/doc-patterns.md),定位新增或修改的函数、类、方法,添加或更新文档块。若存在 /docs 文件夹,则检查改动代码是否有对应文档,并更新受影响的文档文件。明确不修改 README.md、CHANGELOG.md、LICENSE。
文档风格匹配:始终沿用文件内已有的文档风格,例如已有 PHPDoc 就用 PHPDoc,已有 JSDoc 就用 JSDoc;若没有现成文档,则根据文件扩展名判断。
输出要求:返回一份报告,列出被修改的文件、新增或更新的文档块,以及汇总计数。
限制:仅处理未提交的改动;不触碰 README、CHANGELOG、LICENSE;具体支持的语言栈与格式示例需查阅 references/doc-patterns.md,资料未提供其完整内容。