PHP_CodeSniffer PEAR.Commenting.FunctionComment.ParamNameNoMatch error

Question

Мой исходный код генерирует следующую ошибку с PHP_CodeSniffer. "Doc комментарий для вар & $ MYVAR не соответствует действительному имени переменной $ MYVAR в положении 2"

PEAR.Commenting.FunctionComment.ParamNameNoMatch

Код:

/** 
* Function comment 
* 
* @param object $newVar some comment 
* @param array &$myVar some comment 
* 
* @return null 
*/ 
private function _myFunction($newVar, &$myVar) { 
    // my code here... 
} 

Что может быть причина?

Answer 1

PHPDoc не поддерживает амперсанды, а PHP Codesniffer строго реализует PHPDoc.
Я бы предпочел, чтобы это считалось ошибкой PHPDoc, которой нужно было адресовать, а не иметь совместимость с Codesniffer. Как еще вы подтверждаете, что переменная передается по ссылке ?!

https://github.com/squizlabs/PHP_CodeSniffer/issues/248