⚡

双语JSDoc文档编写Skill bilingual-jsdoc

该技能用于编写和更新fe-tools项目中导出函数的双语（中文+英文）JSDoc文档，确保文档准确性和一致性，提升代码可读性、维护性和团队协作效率。关键词：双语JSDoc、文档编写、前端开发、代码注释、fe-tools、JSDoc修复、TypeScript兼容。

前端开发 0 次安装 0 次浏览 更新于 3/18/2026

name: bilingual-jsdoc 描述：为fe-tools中的导出函数编写或更新双语（中文+英文）JSDoc文档。当用户请求文档更新、JSDoc修复或添加/修改utils、web-utils、node-utils、canvas-utils或ai-utils中的实用程序时使用。

双语JSDoc

工作流程

  1. 确认函数属于哪个包（utils/web-utils/node-utils/canvas-utils/ai-utils），并打开目标模块文件。
  2. 按所需格式编写JSDoc：
    • 中文描述，然后是英文描述
    • @param 行包含中文和英文描述
    • @returns 行包含返回描述
    • 至少两个@example块（常见情况 + 边缘情况，有帮助时添加第三个）
  3. 确保JSDoc中的类型与TypeScript签名匹配。
  4. 保持措辞简洁并与现有风格一致。