如何在JSDoc中记录JSON参数？

Question

我刚开始学习 JSDoc，遇到的第一个难题是如何指示必须是有效 JSON 的函数参数。

我正在查看 @param 的文档，但我找不到：

• @param {JSON}

在 JSDoc 中指示必须是有效 JSON 的函数参数的正确方法是什么？ （使用 @param {string} 肯定不对吧？）

- Rounin

---

JSON文本是一个字符串。JsDoc没有语法来记录字符串的格式，您需要使用参数的文本描述来说明。 - Bergi

@Bergi 或许我可以部署类似这样的东西：@typedef {string} JSON 然后使用 @param {JSON}？（参见：https://jsdoc.app/tags-typedef.html） - Rounin

Answer 1

如果目前没有其他答案，我会选择在 JavaScript 文件顶部定义 JSON 作为一种类型，像这样：

/**
 * Define JSON
 * @typedef {string} JSON
 */

然后，在我的函数定义中使用JSON类型。

请参阅下面以@param开头的行：

/**
 * Compresses JSON data
 * @function compressJSON
 * @param {JSON} myJSON - any valid JSON
 * @returns {string} a compressed version of the JSON input
 */

---

更多阅读：

• https://jsdoc.app/tags-typedef.html

- Rounin - Standing with Ukraine