如何在 JSDoc 中将描述单独添加到示例中？
我想分别为每个代码示例添加描述。
例如：
/**
* 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 中如何做到这一点？
I would like to add a description to each code example individually.
For example:
/**
* 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) {
}
How can this be done in JSDoc?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
根据 http://code.google.com/p 底部的注释/jsdoc-toolkit/wiki/TagExample。
您可以使用 HTML 标记构建复杂的示例块，并使用
引用您的实际示例代码。您可以将描述部分放在 HTML 内部，但在外部。According to the Note at the bottom of http://code.google.com/p/jsdoc-toolkit/wiki/TagExample.
You can build complex example block using HTML markup, and quote your actual example code using
<code>. You can put the Description part inside the HTML, but outside the<code>.