Tag reference
@ignore
The @ignore tag tells documentation-generating tooling to leave the
decorated element out of its output entirely, as if it did not exist. This
is stronger than @internal, which still documents an
element but flags it as an implementation detail not meant for consumers:
@ignore removes it from the generated documentation altogether, which is
useful for scaffolding, deprecated leftovers, or helpers that would only
confuse readers of the public reference.
Grammar
"@ignore" [ <Description> ]Examples
/** * @ignore */protected function debugDump(): void {}/** * @ignore Scaffolding left over from the migration; will be * removed. */Names by platform
- phpdocumentor
@ignore
Parsing an @ignore tag produces an IgnoreTag instance. Being a pure
marker, it adds nothing beyond the $name and optional $description
every Tag already carries.
final class IgnoreTag extends FlagTag {}@ignore is still part of phpDocumentor’s current tag reference and is
not deprecated —
phpDocumentor tag reference.
It is parsed here for compatibility with classic-style docblocks.