PHPUnit dataProvider 的 phpdoc @return 值

Question

是否有一种符合 phpdoc 的方式*来表达 PHPUnit dataProvider 中的各种返回值？

例如：

return array(
    array(false, 17, array(1,2)),
    array(true, 19, array(1,2)),
);

我想写一些比@return array更详细的东西，表示传递给测试方法的第一个值是布尔值，第二个是整数，第三个是数组（还有每个这些值代表）。

* 如果没有合规的方式，有没有人有关于如何以清晰的方式记录的提示？

Answer 1

数组的唯一进一步说明是它们包含的内容（如果总是相同的类型）：

/**
 * @return array[]
 */
function() {
    // ...
}

这个注解表示函数将return一个数组的数组，你可以在这个问题中找到进一步的讨论：

PHPDoc type hinting for array of objects?

注：不是每个IDE都能解读

为了一个可能的清晰方式：在我看来，你总是可以在你的评论中使用代码块来解释你的一些代码：

/**
 * returns array with following structure:
 * <code>
 * array(
 *     array(
 *         (bool), (int), (array)
 *     )
 * )
 * </code>
 *
 * @return array[]
 */

或类似的解释。我敢肯定，有很多方法可以让其他开发人员了解预期结果。最后，如果它不包含在通常的注释中，它只需要是人类可以理解的。

PHPUnit dataProvider 的 phpdoc @return 值

phpdoc @return value for PHPUnit dataProvider

phpunit

phpdoc