Skip to content

Tag reference

@codingStandardsIgnoreFile

The @codingStandardsIgnoreFile tag ignores the whole file for coding-standard checks. This is pre-3.2.0 PHP_CodeSniffer syntax; current PHP_CodeSniffer prefers the phpcs:* comment syntax instead, but still understands it.

Grammar

"@codingStandardsIgnoreFile" [ <Description> ]

Examples

Excluding a generated file.
/**
* @codingStandardsIgnoreFile Generated by bin/build, do not edit.
*/

Names by platform

phpcs
@codingStandardsIgnoreFile

Parsing a @codingStandardsIgnoreFile tag produces a CodingStandardsIgnoreFileTag instance. Being a pure marker, it adds nothing beyond the $name and optional $description every Tag already carries.

final class CodingStandardsIgnoreFileTag extends FlagTag {}

Defined by PHP_CodeSniffer.