phpcs:缺少参数注释

Question

我有以下代码:

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

...我发现当我将鼠标悬停在注释上时，会出现此注释:

phpcs: Missing parameter comment

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

(我试过简单地在参数注释上方添加文本，但似乎无法解决问题。)

Answer 1

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

将您的代码更改为

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