Back to Details

add-documentation

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Add Documentation

添加文档

Purpose

用途

Generate JSDoc/docstrings for functions

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

Routing

使用场景

Use when: Use when users ask for in-code docs, docstring addition, or API-level comments.
Do not use when: Don't use for content translation or narrative changelogs.
Outputs: Updated code artifacts with improved inline documentation.
Success criteria: Retains behavior while improving doc clarity and consistency.

适用场景：当用户需要代码内文档、添加文档字符串或API级注释时使用。
不适用场景：不要用于内容翻译或叙述性更新日志。
输出结果：带有改进型内联文档的更新后代码制品。
成功标准：在保留代码行为的同时，提升文档的清晰度和一致性。

Trigger Examples

触发示例

Positive

适用触发

Use the add-documentation skill for this request.
Help me with add documentation.
Use when users ask for in-code docs, docstring addition, or API-level comments.
Add Documentation: provide an actionable result.

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

Negative

不适用触发

Don't use for content translation or narrative changelogs.
Do not use add-documentation for unrelated requests.
This request is outside add documentation scope.
This is conceptual discussion only; no tool workflow is needed.

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

Parameters

参数

Name	Type	Required	Description
path	string	Yes	Path to the file to document
style	select	Yes	Documentation style

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

Runtime Prompt

运行时提示

Current runtime prompt length: 523 characters.
Runtime prompt is defined directly in
```
../add-documentation.json
```
.

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