在 JSDoc 示例中使用 @ 符号的 VS Code
VS Code with @ sign in JSDoc example
我无法让@符号在@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 的错误?
正如所讨论的那样,这是 JSDoc 的限制 here。作为解决方法,您可能可以使用 unicode @ U+FF20。因此,在您的示例字符串中,将 @ 符号替换为 \uFF20
我无法让@符号在@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 的错误?
正如所讨论的那样,这是 JSDoc 的限制 here。作为解决方法,您可能可以使用 unicode @ U+FF20。因此,在您的示例字符串中,将 @ 符号替换为 \uFF20