phpcodesniffer - PHP_CodeSniffer PEAR.Commenting.FunctionComment.ParamNameNoMatch 错误

Question

我的源代码使用 PHP_CodeSniffer 生成以下错误。“var &$myVar 的文档注释与位置 2 处的实际变量名称 $myVar 不匹配”

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