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

Question

我在 API 中有一个简单的方法，它允许使用 JSONPath 搜索对象。由于初级开发人员对它的语法非常陌生，我决定在 JSDoc 注释中提供一些示例。然而，这里有一个问题， - @ 符号被视为新 jsdoc-tag 的开始，因此描述被破坏。

问题：如何制作 NetBeans（或一般的 jsdoc）忽略特定代码块内的 @ 符号？最好在 @example 块内。 p>

因此，此代码将在工具提示中显示未修改：

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

另外，@example、<code>、<pre> - 不要帮忙。

HTML 实体 @ 在工具提示中转换为 @，但它在代码本身中看起来不可读（$..book[?(@.price<10)]）并且它只在 main 中工作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
 */

使工具提示显示如下：