apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: CommentedOutCodeSniff

Source Location: /PHP_CodeSniffer-3.1.1/src/Standards/Squiz/Sniffs/PHP/CommentedOutCodeSniff.php

Class Overview


Warn about commented out code.


Author(s):

Copyright:

  • 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 17]
Warn about commented out code.


[ Top ]


Class Variables

$maxPercentage =  35

[line 35]

If a comment is more than $maxPercentage% code, a warning will be shown.
  • Access: public

Type:   integer


[ Top ]

$supportedTokenizers = array(
                                   'PHP',
                                   'CSS',
                                  )

[line 25]

A list of tokenizers this sniff supports.
  • Access: public

Type:   array


[ Top ]



Method Detail

process   [line 59]

void process( File $phpcsFile, int $stackPtr)

Processes this test, when one of its tokens is encountered.
  • Access: public

Parameters:

\PHP_CodeSniffer\Files\File   $phpcsFile   —  The file being scanned.
int   $stackPtr   —  The position of the current token in the stack passed in $tokens.

[ Top ]

register   [line 43]

array register( )

Returns an array of tokens this test wants to listen for.
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:27:18 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.