AgentSkillsCN

bilingual-jsdoc

为 fe-tools 中导出的函数编写或更新中英双语 JSDoc 文档。当用户提出更新文档、修复 JSDoc，或在 utils、web-utils、node-utils、canvas-utils 或 ai-utils 中新增/修改工具时，可使用此技能。

SKILL.md
--- frontmatter
name: bilingual-jsdoc
description: Write or update bilingual (Chinese + English) JSDoc for exported functions in fe-tools. Use when the user asks for documentation updates, JSDoc fixes, or when adding/modifying utilities in utils, web-utils, node-utils, canvas-utils, or ai-utils.

Bilingual JSDoc

Workflow

  1. •Confirm which package the function belongs to (utils/web-utils/node-utils/canvas-utils/ai-utils) and open the target module file.
  2. •Write JSDoc in the required format:
    • •Chinese description, then English description
    • •@param lines with Chinese and English descriptions
    • •@returns line with return description
    • •At least two @example blocks (common case + edge case, add a third when helpful)
  3. •Ensure types in JSDoc match the TypeScript signature.
  4. •Keep wording concise and consistent with existing style.