Source for file PostStatementCommentSniff.php
Documentation is available at PostStatementCommentSniff.php
* Checks to ensure that there are no comments after statements.
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class PostStatementCommentSniff implements Sniff
* A list of tokenizers this sniff supports.
public $supportedTokenizers = array (
* Returns an array of tokens this test wants to listen for.
public function register ()
* Processes this sniff, when one of its tokens is encountered.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token in the
* stack passed in $tokens.
public function process (File $phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens ();
if (substr($tokens[$stackPtr]['content'], 0 , 2 ) !== '//') {
$commentLine = $tokens[$stackPtr]['line'];
$lastContent = $phpcsFile->findPrevious (T_WHITESPACE , ($stackPtr - 1 ), null , true );
if ($tokens[$lastContent]['line'] !== $commentLine) {
// Special case for JS files.
if ($tokens[$lastContent]['code'] === T_COMMA
$lastContent = $phpcsFile->findPrevious (T_WHITESPACE , ($lastContent - 1 ), null , true );
$error = 'Comments may not appear after statements';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'Found');
$phpcsFile->fixer ->addNewlineBefore ($stackPtr);
Documentation generated on Mon, 11 Mar 2019 15:27:42 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|