代码块中的jsdoc @字符

Question

我正在尝试为这样的Module函数编写文档：

/**
 * Usage:
 *
 * ```
 * @NgModule({
 *      imports: [
 *          BrowserModule,
 *          ...,
 *          ThisModule.forRoot({
 *              name: 'Name',
 *              version: '1.0',
 *      ],
 * }),
 * ```
 * 
 * @param config Service configuration parameters
 */
public static forRoot(config: SVConfig) {

问题出在@NgModule上。我尝试过：

* ```
* @NgModule

似乎html实体在代码外部运行良好（```），但不在代码块内部（它做了一些奇怪的事情，比如用粗体和新行制作qazxsw poi）

也试过NgModule，\@，{@literal @}，\u0064没有成功。我发现最友好的是@@。

有什么建议吗？

Answer 1

遗憾的是，(@)NgModule块中的jsDoc不支持特殊符号。它们只在内联代码块中工作，如下所示：

@example

这将导致正确的

```js
@Module
```

输出。

与@Module不同，你不能在所有内容之后放置一个内联代码块，因为它是内联的，这意味着它将在你的@example部分之前的某个地方。我知道，很尴尬。

当您想在代码示例中使用多行注释等内容时也是如此。

@returns

输出：

```js
a.setParams(/* parameters here */);
```

Answer 2

我很幸运在unicode空间中使用了替代的@符号：a.setParams(/* parameters here */);。它使文档看起来正确，但遗憾的是，如果有人复制/粘贴代码块，它将无法工作。至少从2012年开始这似乎是一个悬而未决的问题所以我不会屏住呼吸以获得更好的解决方案。