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

Question

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

问题：如何使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。

Answer 2

不确定这是否适用于所有环境，但是当在typescript（.ts）文件上使用VSCode时，我能够使用模板字符串来实现良好显示的示例代码

/**
 * @description
 * This function totally does something.
 *
 * @example```
import { SomeThing } from '@mycompany/my-cool-library';

DoSomething(SomeThing)```
 * 
 * @returns string
 */

使工具提示显示如下：