如何在 JSDoc 中记录 JSON 参数？

Question

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

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

@param {JSON}

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

(用[=17=肯定不对吧？)

Answer 1

在目前没有任何其他答案的情况下，我打算将 JSON 定义为 [=33= 顶部的 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

如何在 JSDoc 中记录 JSON 参数？

How to document a JSON parameter in JSDoc?

javascript

parameters

json

jsdoc