add-documentation

添加文档

用途

为函数生成 JSDoc/文档字符串

路由

• 使用时机：用户要求添加代码内文档、添加文档字符串或 API 级注释时使用。
• 不使用时机：不要用于内容翻译或叙述性变更日志。
• 输出：更新后的代码文件，并改进内联文档。
• 成功标准：在保留行为的同时，提高文档的清晰度和一致性。

触发示例

正向

• 此请求请使用 add-documentation 技能。
• 帮我添加文档。
• 用户要求添加代码内文档、添加文档字符串或 API 级注释时使用。
• 添加文档：提供可执行的结果。

负向

• 不要用于内容翻译或叙述性变更日志。
• 不要将 add-documentation 用于无关请求。
• 此请求不属于添加文档的范围。
• 这只是概念讨论，无需使用工具工作流。

参数

名称	类型	必填	描述
path	string	是	要添加文档的文件路径
style	select	是	文档风格

运行时提示词

• 当前运行时提示词长度：523 个字符。
• 运行时提示词直接定义在 ../add-documentation.json 中。