我在API中有一个简单的方法,它允许使用JSONPath搜索对象。由于它的语法对于初级开发人员来说几乎是不熟悉的,所以我决定在JSDoc注释中提供一些示例。然而,这是捕获, - @
符号被视为新jsdoc-tag的开头,因此描述被破坏。
问题:如何制作NetBeans (或一般的jsdoc)忽略特定代码块内的@
符号?最好在@example
内块。
所以这段代码在工具提示中显示未经修改:
$..book[?(@.price<10)] // - filter all books cheaper than 10
此外,@example
,<code>
,<pre>
- 没有帮助。
Html实体@
在工具提示中转换为@
,但在代码本身($..book[?(@.price<10)]
)和它只在主jsdoc文本中工作......
答案 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)