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

时间:2012-04-19 08:01:18

标签: javascript netbeans jsdoc

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

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

所以这段代码在工具提示中显示未经修改:

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

此外,@example<code><pre> - 没有帮助。

Html实体&#64;在工具提示中转换为@在代码本身($..book[?(&#64;.price<10)]和它只在主jsdoc文本中工作......

2 个答案:

答案 0 :(得分:3)

这是一个非常古老的问题,但我遇到了同样的问题,除了在VSCode中,并且我认为我可以分享一个可能的解决方案。

最终工作的是移动@returns 以下示例,不幸的是,没有使用@example,例如:

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

这不太理想,但适用于VSCode的工具提示;我不确定它是否适用于NetBeans。

答案 1 :(得分:2)

不确定这是否适用于所有环境,但是在打字稿(.ts)文件上使用VSCode时,我能够使用模板字符串来获得显示效果很好的示例代码

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

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

使工具提示显示如下:

escaping_the_@_sign