双语JSDoc文档编写Skill bilingual-jsdoc

该技能专注于为前端开发工具中的函数编写双语(中文和英文)JSDoc 文档,以提升代码可读性、维护性和团队协作效率,适用于国际化项目。关键词:JSDoc、双语文档、前端开发、代码注释、文档生成、软件开发工具。

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

name: bilingual-jsdoc description: 为 fe-tools 中的导出函数编写或更新双语(中文+英文)JSDoc。当用户请求文档更新、JSDoc 修复或添加/修改实用程序时使用。

双语 JSDoc

工作流程

  1. 打开目标模块文件并定位导出的函数。
  2. 以所需格式编写 JSDoc:
    • 中文描述,然后英文描述
    • @param 行带有中文和英文描述
    • @returns 行带有返回描述
    • 至少两个 @example 块(常见情况 + 边缘情况)
  3. 确保 JSDoc 中的类型与 TypeScript 签名匹配。
  4. 保持措辞简洁并与现有风格一致。