如何在 JSDoc 中记录 JSON 参数？

Posted 2023-02-18

【中文标题】如何在 JSDoc 中记录 JSON 参数？

【英文标题】：How to document a JSON parameter in JSDoc?

【发布时间】：2022-01-16 11:17:28

【问题描述】：

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

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

@param JSON

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

（用@param string肯定不对吧？）

【问题讨论】：

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

@Bergi 也许我可以部署类似：@typedef string JSON，然后使用@param JSON？ （见：jsdoc.app/tags-typedef.html）

【参考方案1】：

在目前没有任何其他答案的情况下，我将在 javascript 文件的顶部将 JSON 定义为 type，如下所示：

/**
 * 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