如何在 JSDoc 中记录 JSON 参数？

Question

我刚刚开始学习JSDoc ，遇到的第一个障碍是如何指示function 参数，该参数必须是有效JSON 。

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

• @param {JSON}

JSDoc中指示function 参数的正确方法是什么，该参数必须是有效JSON ？

（当然使用@param {string}是不对的，是吗？）

Answer 1

到目前为止，在没有任何其他答案的情况下，我将使用 go 将JSON定义为 javascript 文件顶部的类型，如下所示：

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

然后，稍后，在我的 function 定义等中使用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