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部分之前的某个位置。

很尴尬，我知道，但是别无选择。