gpt4 book ai didi

arrays - phpDoc 有没有办法将对象数组记录为参数?

转载 作者:行者123 更新时间:2023-12-03 11:49:07 25 4
gpt4 key购买 nike

在 phpDoc 生成的文档中,我可以使 phpDoc 使用

@param CustomType $variablename

这很好用。但是,我目前正在记录的代码需要 CustomType[] 参数,即上述 CustomType 的数组。我希望文档清楚表明需要一个数组,但是当我使用
@param CustomType[] $variablename

phpDoc 不再识别类型,因此无法链接到它的定义。这在这种情况下非常重要 - 我正在记录一个 API,该 API 需要提供一些相当复杂的类型。

我为此尝试了几种不同的语法,并且都将条目视为单独的变量类型或在文档中中断类型识别。

除此之外,我只会在参数注释中注明,但在类型中显示参数的数组性似乎更清楚。

编辑

使用 phpDocumentor 2(与 DocBlox 合并)
@param CustomType[] $paramName

语法有效,正如@Styx 的回答中所述,PhpStorm 支持使用该语法进行类型提示。

已接受的答案已适当更新。

最佳答案

新版 PHP 文档支持 /** @var sometype[] */句法。更复杂:/** @var (sometype|othertype)[] */ . http://www.phpdoc.org/docs/latest/guides/types.html#arrays
PHPStorm 也支持这种语法。

关于arrays - phpDoc 有没有办法将对象数组记录为参数?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/9132062/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com