📋 输入函数代码
📄 生成的JSDoc注释
在上方输入函数代码后点击生成
📖 什么是JSDoc?
JSDoc是一种用于JavaScript的API文档生成标记语言。通过在源代码中添加JSDoc注释,可以自动生成API文档,同时为IDE提供智能提示和类型检查。
JSDoc注释格式
JSDoc注释以 /** 开头,以 */ 结尾,每行以 * 开头。
常用标签
@param - 参数描述 | @returns / @return - 返回值 | @typedef - 自定义类型 | @callback - 回调类型 | @example - 示例代码 | @deprecated - 已废弃 | @see - 参考链接 | @throws - 异常说明
支持的函数格式
✅ function声明 | ✅ 箭头函数 | ✅ 类方法 | ✅ async函数 | ✅ generator函数 | ✅ 默认参数 | ✅ 解构参数 | ✅ rest参数 | ✅ TypeScript类型注解
❓ 常见问题
JSDoc生成器是免费的吗?
是的,完全免费使用,无需注册,无需登录,所有功能都可以直接使用。
代码会上传到服务器吗?
不会。所有处理都在你的浏览器中完成,代码不会上传到任何服务器。即使断开网络也能正常使用。
支持TypeScript吗?
支持。工具可以解析TypeScript函数签名,自动提取参数类型和返回值类型,生成对应的JSDoc注释。
生成的注释可以编辑吗?
可以。生成后你可以手动编辑JSDoc注释内容,添加描述、示例代码、自定义标签等。
支持哪些函数格式?
支持function声明、箭头函数、类方法、async函数、generator函数、默认参数、解构参数、rest参数等常见格式。