如何在 JSDoc 中单独将描述添加到示例中？

【问题标题】：How can a description be added to examples individually in JSDoc?如何在 JSDoc 中单独将描述添加到示例中？
【发布时间】：2021-12-03 06:11:15
【问题描述】：

我想分别为每个代码示例添加说明。

例如：

/**
 * Test function, normal description
 *
 * THE DESCRIPTION OF THE EXAMPLE HERE
 * @example
 * fooBar("foo", "bar");
 * 
 * THE DESCRIPTION OF ANOTHER EXAMPLE HERE
 * @example
 * fooBar("bar", "foo", false);
 */ 
function fooBar (param1, param2, param3) {
}

在 JSDoc 中如何做到这一点？

【问题讨论】：

标签： javascript documentation jsdoc

【解决方案1】：

根据http://code.google.com/p/jsdoc-toolkit/wiki/TagExample底部的注释。

您可以使用 HTML 标记构建复杂的示例块，并使用 <code> 引用您的实际示例代码。您可以将描述部分放在 HTML 中，但在 <code> 之外。

【讨论】：

谢谢！但我一直在寻找一种更“原生”的方法。可能是 JSDoc 中有标签之类的。