Squiz_Sniffs_PHP_CommentedOutCodeSniff
in package
implements
PHP_CodeSniffer_Sniff
Squiz_Sniffs_PHP_CommentedOutCodeSniff.
Warn about commented out code.
Tags
Interfaces, Classes and Traits
- PHP_CodeSniffer_Sniff
- Represents a PHP_CodeSniffer sniff for sniffing coding standards.
Table of Contents
- $maxPercentage : int
- If a comment is more than $maxPercentage% code, a warning will be shown.
- $supportedTokenizers : array<string|int, mixed>
- A list of tokenizers this sniff supports.
- process() : void
- Processes this test, when one of its tokens is encountered.
- register() : array<string|int, mixed>
- Returns an array of tokens this test wants to listen for.
Properties
$maxPercentage
If a comment is more than $maxPercentage% code, a warning will be shown.
public
int
$maxPercentage
= 35
$supportedTokenizers
A list of tokenizers this sniff supports.
public
array<string|int, mixed>
$supportedTokenizers
= array('PHP', 'CSS')
Methods
process()
Processes this test, when one of its tokens is encountered.
public
process(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : void
Parameters
- $phpcsFile : PHP_CodeSniffer_File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
Return values
void —register()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, mixed>