visual-studio-code - JSDoc 示例中带有 @ 符号的 VS Code

标签 visual-studio-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();

还有
从 '@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/

相关文章:

javascript - jsDoc - 如何指定数组长度

javascript - JSDoc 中对象中任意键的值的文档结构

java - 在 Mac 上的 VSCode 中将 Java 编译成应用程序

visual-studio-code - 更改 VSCode 小 map 颜色

node.js - 为什么 VS Code 中的 Nodejs 断点会根据选项卡标题中是否出现完整路径而被禁用?

javascript - 如何让 JSDoc 记录我的 _methods?

visual-studio-code - 从 Finder 打开文件时,Visual Studio Code 替换了我打开的选项卡

visual-studio-code - VSCode中的ESLint无法在保存时修复

javascript - 生成 JSDoc 的参数和子参数数组

javascript - 用于 jsDoc 注释的正则表达式