我只是无法让 @ 符号在 @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();
还有
从 '@nexsolab/common-network' 导入 { BadRequestError };
* import { BadRequestError } from '@nexsolab/common-network';
不起作用。
我忘记了什么或者这是 VS Code 的错误?
最佳答案
这是 JSDoc 的限制,正如所讨论的 here 。作为解决方法,您可能可以使用 unicode @ U+FF20。因此,在您的示例字符串中,将 @ 符号替换为\uFF20
关于visual-studio-code - JSDoc 示例中带有 @ 符号的 VS Code,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/64761635/