How to escape @ sign inside JSDoc comments in NetBeans

This is a pretty old question, but I was having the same problem, except in VSCode and thought I'd share a possible solution.

What finally worked was moving @returns below the example and, unfortunately, not using @example, e.g.:

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

This is not ideal, but works for VSCode's tooltip; I'm not sure if it'll work with NetBeans.

Not sure if this will work everywhere, but in Visual Studio Code, the blank braille character ⠀ (U+2800) works well for escaping @:

/** * Persists an Subject's value to localStorage and restores it on initialization. * When the subject's value changes, it will automatically be saved to localStorage. * @example * ``` * class MyComponent { * ⠀@Persist() * public readonly theme$ = new Subject<string>('light'); // light by default * } * ``` */ 

Also, this character appears to be supported by Cascadia Mono—therefore it won't produce weird non-monospace offsets.

Not sure if this will work for all environments, but when using VSCode on a typescript (.ts) file I was able to use template strings to achieve nicely displayed example code

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

Makes the tooltip display like:

-- For anyone struggling with this in the future --

A round about solution is to use the '＠' - U+FF20 character instead. It appears a little bit bigger than the actual '@' but does the job regardless of the editor/environment. This works as long as no one actually tries to copy the example code, in which case most modern editors/IDEs should highlight the unusual Unicode character.

All the answers here don't work for me.

Finally I found a solution: There's a plugin jsdoc-escape-at that allows to escape with backslash: \@

Example:

/** Implements Signal / Slot - Observer Pattern @example \@Emitter class A { constructor(private x) {} \@Signal test(x) {} emitTest = () => this.test(this.x) } */ export function Emitter(target: any) { // add function to register slot, called by Observer constructor target.prototype.__REGISTER_SLOT = function (key, slotFn) { ((this.__SLOTS ??= {})[key] ??= []).push(slotFn) } return target } 

Generates:

Emitter() Implements Signal / Slot - Observer Pattern Source: observe.ts, line 64 Example @Emitter class A { constructor(private x) {} @Signal test(x) {} emitTest = () => this.test(this.x) }