Search code examples
visual-studio-codejsdoc

VS Code with @ sign in JSDoc example

I just cann't make @ sign works inside a code block in @example JSDoc attribute, this always break the visualization:
Original:

   * @example
   * ```js
   * import { BadRequestError } from '@nexsolab/common-network';
   * 
   * const error = new BadRequestError()
   *   .addInvalidParam('token', 'Token should be informed')
   *   .mount();
   * ```

VS Code rendered tip:

@example

import { BadRequestError } from '  

*@nexsolab*  
/common-network';

const error = new BadRequestError()
.addInvalidParam('token', 'Token should be informed')
.mount();

Also
import { BadRequestError } from '@nexsolab/common-network';
* import { BadRequestError } from '@nexsolab/common-network';
doesn't works.

I forgot something or this is a VS Code bug?

Solution

  • This is a limitation of JSDoc as discussed here. As a workaround you could probably use the unicode @ U+FF20. So in your example string substitute the @ symbol with \uFF20