首页 > 解决方案 > 带有@符号的VS Code在JSDoc示例中

问题描述

我只是不能让@符号在@example JSDoc 属性中的代码块内工作,这总是会破坏可视化:
原文:

   * @example
   * ```js
   * import { BadRequestError } from '@nexsolab/common-network';
   * 
   * const error = new BadRequestError()
   *   .addInvalidParam('token', 'Token should be informed')
   *   .mount();
   * ```

VS Code 渲染提示:

@example

import { BadRequestError } from '  

*@nexsolab*  
/common-network';

const error = new BadRequestError()
.addInvalidParam('token', 'Token should be informed')
.mount();


import { BadRequestError } from '@nexsolab/common-network';
* import { BadRequestError } from '@nexsolab/common-network';
不起作用。

我忘记了什么或者这是一个 VS Code 错误?

标签: visual-studio-codejsdoc

解决方案


这是此处讨论的 JSDoc 的限制。作为一种解决方法,您可能可以使用 unicode @ U+FF20。因此,在您的示例字符串中,将 @ 符号替换为 \uFF20


推荐阅读