Kit 工具函数文档模板
本文档提供了为 @esdora/kit 中的工具函数编写和生成文档的唯一标准。
文档结构模板
每个 kit 函数的文档页面都必须遵循以下 Markdown 结构：
markdown
# [函数名]
## 示例
### 基本用法
...
### [场景...]
...
## 签名与说明
...
## 注意事项与边界情况
...
## 相关链接
- 源码: ...AI 生成提示词 (推荐)
我们强烈推荐使用以下 AI 提示词来生成文档初稿。
提示词内容
text
# 上下文与角色 (Context & Role)
你是一位经验丰富的开源项目维护者和技术文档专家。你正在为一个名为 "Dora Pocket" 的项目撰写函数参考文档。具体来说，是为其下的 `@esdora/kit` TypeScript 工具函数库编写内容。你的写作风格应该清晰、专业，并始终以开发者体验为中心。
# 任务 (Task)
你的任务是为我提供的一个函数，生成一份完整、准确、专业的 Markdown 格式的文档页面。
# 输入 (Input)
我将为你提供两部分核心信息：
1. 函数源码: 包含完整的函数实现和 JSDoc 注释。
2. 单元测试代码: 包含针对该函数的、使用 Vitest 编写的全面测试用例。
# 输出格式 (Markdown 模板)
---
title: [函数名]
description: "[函数名] - Dora Pocket 中 @esdora/kit 库提供的[内容类别]工具函数，用于[功能描述]。"
---
```markdown
# [函数名]
## 示例
... (此处省略模板细节)
## 签名与说明
... (此处省略模板细节)
## 注意事项与边界情况
... (此处省略模板细节)
## 相关链接
- 源码: `packages/kit/src/[分类]/[函数名]/index.ts`(注意：为保持本页简洁，省略了模板内部的详细结构，实际使用时请参考完整版提示词。)
核心指令与规范
- 综合分析: 必须结合源码和测试用例。
- 示例格式: 输出使用
// =>行内注释。 - 签名与说明: 合并所有技术信息，优化 JSDoc。
- 注意事项: 必须从测试用例中总结。
- 相关链接: 只包含源码链接，并遵循特定格式。
- 语言: 简体中文。
> **提示**: 上述提示词的完整版本，请参考项目仓库中的原始文件。我们鼓励你直接复制那个文件中的内容来使用。