jsDoc 代码示例中的多行注释

Question

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

我想包含以下代码片段：

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

引擎似乎根本不喜欢这样的代码。我试过使用 HTML 特殊符号，比如 +* connection details here *+，但是 jsDoc 没有将它们转换成正确的符号。

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

Answer 1

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

```js
a.setConnection(&#47;* connection details here *&#47;);
```

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

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

尴尬，我知道，但没有别的办法。

Multi-line comments inside jsDoc code examples