phpcs：缺少参数注释

Question

我有以下代码：

/**
 * @param TranscodingJob $transcodingJob
 *
 * @return TranscodingJob
 * @throws \Lexik\Bundle\WorkflowBundle\Exception\WorkflowException
 */
public function onTranscodingJobError(TranscodingJob $transcodingJob) { ...

...，当我将鼠标悬停在注释上时，便会显示以下注释：

  

phpcs：缺少参数注释

如何修改注释以使投诉消失？

（我尝试在参数的注释上方简单地添加文本，但这似乎无法解决问题。）

Answer 1

您需要为@param变量添加注释

将代码更改为

 /**
 * @param TranscodingJob $transcodingJob comment about this variable
 *
 * @return TranscodingJob
 * @throws \Lexik\Bundle\WorkflowBundle\Exception\WorkflowException
 */