14

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

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

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

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

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

Html 实体在工具提示&#64;中转换为,它在代码本身 ( )中看起来不可读,并且它仅在主要 jsdoc 文本中工作......@$..book[?(&#64;.price<10)]

4

2 回答 2

5

这是一个很老的问题,但我遇到了同样的问题,除了在 VSCode 中,我想我会分享一个可能的解决方案。

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

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

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

于 2018-04-13T06:11:08.807 回答
2

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

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

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

使工具提示显示如下:

转义_the_@_sign

于 2019-04-19T16:40:06.337 回答