如何在NetBeans中的JSDoc注释中转义@符号

Question

我在API中有一个简单的方法,允许使用JSONPath搜索对象.由于它的语法对于初级开发人员来说几乎是不熟悉的,所以我决定在JSDoc注释中提供一些示例.然而,这里是catch, - @sign被视为新jsdoc-tag的开头,因此描述被破坏了.

问题:如何使NetBeans(或一般的jsdoc)忽略@特定代码块内的符号？优选地,在@example块内.

因此,此代码将在工具提示中显示未修改:

$..book[?(@.price<10)] // - filter all books cheaper than 10

此外,@example,<code>,<pre>-不帮.

Html实体@转换为@工具提示,但它在代码本身看起来不可读($..book[?(&#64;.price<10)])并且它只在主jsdoc文本中工作...

Answer 1

这是一个很老的问题，但我遇到了同样的问题，除了在 VSCode 中，我想我会分享一个可能的解决方案。

最终起作用的是在示例@returns 下方移动，不幸的是，没有使用@example，例如：

/**
 * some description
 * 
 * For example:
 * ```js
 * $..book[?(@.price<10)] // - filter all books cheaper than 10
 * ```
 * @returns {*} whatever you're returning
 */

这并不理想，但适用于 VSCode 的工具提示；我不确定它是否适用于 NetBeans。