无需登录 数据私有 本地保存

JSDoc 注释在线生成器 - 根据函数自动生成文档

开发工具 文档 JSDoc 文档 注释 生成器
37
0
0
0
粘贴函数代码
简单函数 异步函数 箭头函数 类方法 TypeScript
生成的 JSDoc 注释 
等待输入函数代码...
常见问题与知识点

JSDoc 是 JavaScript 的文档注释标准，使用 /** ... */ 格式。它可以帮助开发者理解代码功能，并且能被 VS Code、WebStorm 等编辑器实时解析，在鼠标悬停时显示函数签名和描述。配合 TypeScript 或 eslint 规则，还能做类型检查。常见的标签包括 @param（参数）、@returns（返回值）、@throws（异常）、@async（异步）等。

箭头函数的 JSDoc 注释写在变量声明上方即可：
/** @type {(a: number, b: number) => number} */
const add = (a, b) => a + b;
或者使用完整的多行格式，包含 @param 和 @returns 标签。本工具会自动检测箭头函数并生成对应注释。

常用类型包括：{string}、{number}、{boolean}、{Array}、{Object}、{Function}、{Promise}、{*}（任意类型）。对于数组元素类型可写为 {string[]} 或 {Array<string>}。可选参数使用方括号：@param {string} [name='默认值']。本工具会根据默认值自动推断类型。

异步函数使用 @async 标签标记，返回值类型应写为 @returns {Promise<string>} 这样的形式。本工具会自动检测 async 关键字，并在生成的注释中添加 @async 标签，同时将返回值包装为 Promise 类型。

完全支持。如果函数包含 TypeScript 类型注解（如 param: string、返回类型 : number、泛型 <T>），本工具会优先使用这些类型信息生成更精确的 JSDoc 注释。对于泛型函数，还会自动添加 @template 标签。

是的，生成的注释遵循 JSDoc 标准格式。不过参数描述和返回值描述是自动生成的占位文本（标记为 TODO），建议你根据实际业务语义修改这些描述，使其更加准确。类型推断部分通常可以直接使用。
🔧 相关工具