@ignore
Syntax
@ignore
Overview
@ignore instructs JSDoc to skip a symbol entirely – it will not appear in the output. Use it on symbols that are implementation details, auto-generated, or otherwise not part of the public API.
Example
/**
* @ignore
*/
function _internalHelper() {}
class MyClass {
/**
* @ignore
*/
_cache = null;
}
tip
If you want to document a symbol but restrict its visibility, use @private instead.