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

Question

我想分别为每个代码示例添加描述。

例如：

/**
 * 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 中做到这一点？

Answer 1

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

您可以使用 HTML 标记构建复杂的示例块，并使用<code>. 您可以将描述部分放在 HTML 中，但在<code>.