字符串映射为 string,所有数字映射为 number,布尔值映射为 boolean,数组根据其第一个元素映射为 type[]。每个嵌套对象都有自己的 @typedef,并按名称引用。

null 或空数组怎么办?

无法从样本推断其类型,因此 null 映射为 * (any),空数组映射为 *[]。如果你知道真实类型,可手动收紧。

为什么用 JSDoc 而非 TypeScript?

JSDoc @typedef 让你无需添加构建步骤或 .ts 文件,即可为纯 JavaScript 编写文档并进行类型检查(例如使用 VS Code 或 tsc --checkJs)。

我的 JSON 会被发送到某处吗?

不会。转换完全在你的浏览器中进行,不会上传任何内容。

JSON 转 JSDoc @typedef 生成器

开发

粘贴任意 JSON 对象或数组,即可获得可直接使用的 JSDoc @typedef 定义:每个字段映射为 JSDoc 类型(string、number、boolean、type[]),嵌套对象生成独立的 @typedef 块。非常适合在不使用 TypeScript 的情况下为纯 JavaScript 添加类型。null 和空数组映射为 * (any) 类型。全部在浏览器本地运行——你的 JSON 不会被上传。

—

根 typedef 名称JSON 输入

JSDoc typedef

/**
 * @typedef {Object} Root
 * @property {string} name
 * @property {number} age
 * @property {boolean} active
 * @property {string[]} tags
 * @property {Meta} meta
 */

/**
 * @typedef {Object} Meta
 * @property {string} id
 */

使用方法

在输入框中粘贴或输入你的 JSON。
可选地重命名根 typedef(默认 Root)。
将生成的 @typedef 块复制到你的 JavaScript 源码中。

常见问题

类型如何映射?: 字符串映射为 string,所有数字映射为 number,布尔值映射为 boolean,数组根据其第一个元素映射为 type[]。每个嵌套对象都有自己的 @typedef,并按名称引用。
null 或空数组怎么办?: 无法从样本推断其类型,因此 null 映射为 * (any),空数组映射为 *[]。如果你知道真实类型,可手动收紧。
为什么用 JSDoc 而非 TypeScript?: JSDoc @typedef 让你无需添加构建步骤或 .ts 文件,即可为纯 JavaScript 编写文档并进行类型检查(例如使用 VS Code 或 tsc --checkJs)。
我的 JSON 会被发送到某处吗?: 不会。转换完全在你的浏览器中进行,不会上传任何内容。

JSON 转 JSDoc @typedef 生成器

使用方法

常见问题

相关工具

Base64 与十六进制互转

Quoted-Printable 编码与解码

哈希生成器 (SHA)

URL 编码 / 解码

Base64 编码 / 解码

JSON 格式化与校验工具