phpcs：缺少参数注解

b0zn9rqh 于 2023-05-05 发布在 PHP

关注(0)|答案(2)|浏览(198)

我有以下代码：

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

...我发现当我将鼠标悬停在注解上时，会出现以下注解：
phpcs：缺少参数注解

如何修改我的注解以消除投诉？

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

php

来源：https://stackoverflow.com/questions/51722886/phpcs-missing-parameter-comment

2条答案

按热度按时间

sr4lhrrt1#

您需要为@param变量添加注解
将代码更改为

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

赞(0）回复(0）举报 2023-05-05

rjjhvcjd2#

此错误消息表明PHP代码中缺少参数注解，这会导致运行PHP CodeSniffer（phpcs）工具时出现问题。下面是如何为函数添加参数注解的示例：

/**
 * Adds two numbers together.
 *
 * @param int $num1 The first number to add.
 * @param int $num2 The second number to add.
 *
 * @return int The sum of the two numbers.
 */
function addNumbers($num1, $num2) {
    return $num1 + $num2;
}

赞(0）回复(0）举报 2023-05-05

我来回答

phpcs：缺少参数注解

2条答案

相关问题

热门标签

最新问答