jsdoc - jsDoc代码示例中的多行注释

Question

我们如何在 jsDoc 示例中使用多行注释？

我想包含以下代码片段：

/**
* @example
*
* a.setConnection(/* connection details here */);
*
*/

引擎似乎根本不喜欢这样的代码。我曾尝试使用 HTML 特殊符号，例如+* connection details here *+，但 jsDoc 不会将它们转换为正确的符号。

我们怎样才能让它发挥作用？

Answer 1

正如我自己发现的那样，@example块内的 jsDoc 不支持特殊符号。它们仅在内联代码块内工作，如下所示：

```js
a.setConnection(/* connection details here */);
```

输出：a.setConnection(/* connection details here */);

但与 不同@example的是，您不能在所有内容之后放置内联代码块，因为它是内联的，这意味着它将位于您的@returns部分之前的某个位置。

尴尬，我知道，但没有其他办法。