my sniff不起作用,也无法识别private$testvar属性。我想在那里强制设置文档块。
当我运行代码嗅探器时,进程方法似乎没有被使用。我之前在那里加了一些回声。
令牌T_PROPERTY是否存在?我在php手册上找不到它http://php.net/manual/en/tokens.php然而,在squiz实验室中使用了源代码T_PROPERTY。
<?php
/**
* Extension for the pear class comment sniff.
*
*/
/**
* Extension for the pear class comment sniff.
*
*/
class XYZ_Sniffs_Commenting_PropertyCommentSniff implements PHP_CodeSniffer_Sniff
{
private $testvar = 1;
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array
*/
public function register()
{
return array(T_PROPERTY);
}
/**
* Checks the property comments.
*
* @param PHP_CodeSniffer_File $phpcsFile the file object
* @param int $stackPtr the stack pointer
*
* @return void
*/
public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();
$find = PHP_CodeSniffer_Tokens::$scopeModifiers;
$find[] = T_WHITESPACE;
$find[] = T_STATIC;
$commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true);
if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG
&& $tokens[$commentEnd]['code'] !== T_COMMENT
) {
$phpcsFile->addError('Missing property doc comment', $stackPtr, 'Missing');
$phpcsFile->recordMetric($stackPtr, 'Function has property comment', 'no');
return;
} else {
$phpcsFile->recordMetric($stackPtr, 'Function has property comment', 'yes');
}
}
}
谢谢你的帮助:)。
T_PROPERTY令牌仅在检查JavaScript文件时使用。它不适用于PHP文件。
对于PHP文件,您需要使用AbstractVariableSniff帮助程序。下面是一个检查成员vars注释的嗅探:https://github.com/squizlabs/PHP_CodeSniffer/blob/master/CodeSniffer/Standards/Squiz/Sniffs/Commenting/VariableCommentSniff.php
请注意它是如何扩展PHPCodeSniffer_Standards_AbstractVariableSniff,然后只实现processMemberVar()方法的。它将processVariable()和processVariableInString()方法留空,因为它不关心代码中的常规变量。
还要注意的是,如果您正在编写注释嗅探器,则注释解析器在2.0版本中是完全不同的(目前处于测试版,但预计任何一周都会稳定)。在这里查看上述嗅探的新版本:https://github.com/squizlabs/PHP_CodeSniffer/blob/phpcs-fixer/CodeSniffer/Standards/Squiz/Sniffs/Commenting/VariableCommentSniff.php