JSDoc代码块中@NgModule标记显示异常问题求助

我太懂你遇到的这个坑了——JSDoc的解析器会把代码块里以@开头的内容误判成它自己的标签，导致@NgModule显示异常，甚至用HTML实体替换也不管用。这里有两个靠谱的解决办法：

方法一：用反斜杠转义@符号 #

在代码块里的@前面加一个反斜杠\，这样JSDoc就不会把它当成内置标签解析，会正常显示完整的@NgModule。

修正后的JSDoc示例：

/**
 * 用法：
 *
 * ```
 * \@NgModule({
 *   imports: [
 *     BrowserModule,
 *     ...,
 *     ThisModule.forRoot({
 *       name: 'Name',
 *       version: '1.0',
 *     })
 *   ]
 * })
 * ```
 *
 * @param config 服务配置参数
 */
public static forRoot(config: SVConfig) {

方法二：使用JSDoc的@example标签（更规范） #

JSDoc专门提供了@example标签来处理代码示例，用这个标签包裹代码的话，里面的@符号不会被误解析，这也是官方推荐的写法。

示例如下：

/**
 * 用法示例：
 * @example
 * ```typescript
 * @NgModule({
 *   imports: [
 *     BrowserModule,
 *     ...,
 *     ThisModule.forRoot({
 *       name: 'Name',
 *       version: '1.0',
 *     })
 *   ]
 * })
 * ```
 * @param config 服务配置参数
 */
public static forRoot(config: SVConfig) {

这样处理后，不管是@NgModule还是其他带@的Angular装饰器，都能正常显示在JSDoc文档里啦～

内容的提问来源于stack exchange，提问作者Miquel