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

Question

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

问题:如何制作 NetBeans(或一般的 jsdoc)忽略 @在特定代码块内签名？ 最好在 @example 内 block 。

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

$..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。