PHPUnit数据提供程序的phpdoc@返回值

PHPUnit数据提供程序的phpdoc@返回值,phpunit,phpdoc,Phpunit,Phpdoc,在PHPUnit数据提供程序中是否有一种符合phpdoc的方式*来表示各种返回值 例如: return array( array(false, 17, array(1,2)), array(true, 19, array(1,2)), ); 我想写一些比返回数组更详细的东西,它表示传递给测试方法的第一个值是bool,第二个是整数,第三个是数组(以及这些值各自代表的内容) *如果没有兼容的方法,是否有人有关于如何以清晰的方式记录文档的提示?阵列的唯一进一步规范是它们包含的内容(如

在PHPUnit数据提供程序中是否有一种符合phpdoc的方式*来表示各种返回值

例如:

return array(
    array(false, 17, array(1,2)),
    array(true, 19, array(1,2)),
);
我想写一些比返回数组更详细的东西,它表示传递给测试方法的第一个值是bool,第二个是整数,第三个是数组(以及这些值各自代表的内容)


*如果没有兼容的方法,是否有人有关于如何以清晰的方式记录文档的提示?

阵列的唯一进一步规范是它们包含的内容(如果总是相同的类型):

此注释表示函数将返回数组数组,您可以在此问题中找到进一步的讨论:

注意:不是每个IDE都能解释它

以一种可能清晰的方式:在我看来,您可以在注释中使用代码块来解释一些代码:

/**
 * returns array with following structure:
 * <code>
 * array(
 *     array(
 *         (bool), (int), (array)
 *     )
 * )
 * </code>
 *
 * @return array[]
 */
或者类似的解释。我相信有很多方法可以给其他开发者一个关于预期的提示。最后,如果它没有包含在通常的注释中,那么它只需要是人类可以理解的

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