【问题标题】:How to escape @ symbol in jsdoc for vscode如何在jsdoc中为vscode转义@符号
【发布时间】:2020-09-05 16:32:48
【问题描述】:

在编写jsDoc时,如果它包含@符号,它会抛出VSCode。

符号怎么转义?

我不想使用 HTML 转义码 @,因为它不会在代码块内呈现为 @

【问题讨论】:

  • 能否提供这段代码sn-p的完整文本?
  • 不要发布代码图片,显示filter的实际代码
  • 我尝试了许多不同的结构,但找不到写文字 @ 的方法,JSDoc 文档也没有提到它

标签: visual-studio-code jsdoc


【解决方案1】:

我发现唯一有用的是反引号:

/**
 * @param {type} myVal My val with `@` in the description
 */

这会阻止解析器添加换行符,但确实使 @ 呈现为固定宽度。

【讨论】:

  • 它还在@ 之前和之后放置一个空格,导致结果如下:foo @ bar
  • 啊,公平。我不介意我的用例(并且实际上想要空间)。也许在 VS Code GitHub 页面上提出问题?
猜你喜欢
  • 2012-04-30
  • 1970-01-01
  • 2021-09-15
  • 2018-02-13
  • 2022-11-02
  • 2013-09-15
  • 2016-09-10
  • 2013-11-22
  • 2019-01-17
相关资源
最近更新 更多