【问题标题】:What are valid values for PHPDoc's @param annotation?PHPDoc 的 @param 注释的有效值是什么?
【发布时间】:2013-04-14 11:17:27
【问题描述】:

我在 PHPdocs 上阅读this

数据类型应该是有效的 PHP 类型(int、string、bool 等)”,这很好,但他们没有说明使用哪些字符串(例如 int、string、bool)来标识其他类型.

我猜他们使用 (cast) 语法来确定要用于注释的类型,但是 PHP 中的浮点之类的东西没有强制转换运算符,所以我不确定该使用什么为了那个原因。可能是float,也可能是fp。

有没有人明确列出 PHP 中的基本类型以及应该在 PHPdocs 中使用什么字符串来识别它们?

【问题讨论】:

标签: php phpdoc


【解决方案1】:

文档中都列出了:http://phpdoc.org/docs/latest/references/phpdoc/types.html(原始链接已失效;现在链接到 Internet 存档副本)

对于浮点数,关键字是(逻辑上足够)float


识别以下关键字:

string,该类型适用的元素是二进制的字符串 字符。

integerint,此类型适用的元素是一个整体 数字或整数。

booleanbool,该类型适用的元素只有状态 真假。

floatdouble,此类型适用的元素是 连续或实数。

object,此类型适用的元素是 未定类。

mixed,该类型适用的元素可以是任何类型,如 此处指定。在编译时不知道哪种类型将是 用过。

array,该类型适用的元素是一个值数组, 有关详细信息,请参阅数组部分。

resource,此类型适用的元素是每个 PHP 的定义在 http://www.php.net/manual/en/language.types.resource.php.

void,这种类型一般只在定义返回类型时使用 一种方法或功能。基本定义是元素 用这种类型表示的不包含值,用户应该 不依赖任何检索到的值。

null,此类型适用的元素是 NULL 值,或者,在 技术术语,不存在。

与 void 相比,一个很大的不同是这种类型用于任何 所描述的元素可能在任何给定时间包含一个 显式 NULL 值。

callable,此类型适用的元素是指向函数调用的指针。这可以是任何类型的回调,如 在 PHP 手册中定义 http://php.net/manual/en/language.pseudo-types.php(死链接)。

falsetrue,应用此类型的元素将具有 值真或假。不会从这里返回其他值 元素。

这种类型通常与另一种类型结合使用 表示有可能返回 true 或 false 而不是其他类型的实例。

self,此类型适用的元素属于同一类,或 它的任何子元素,记录的元素最初是 包含。

phpDoc via Internet Archive

【讨论】:

  • 谢谢!我以为我在看“文档”:C 没有意识到那里还有另一个文档提供更多信息。
  • 链接不再指向预期的位置。
  • @BorisD.Teoharov 我更新了链接以使用 Internet 存档并将相关信息添加到答案中。
猜你喜欢
  • 2010-10-05
  • 2014-04-28
  • 2011-06-21
  • 1970-01-01
  • 1970-01-01
  • 2020-08-16
  • 1970-01-01
  • 1970-01-01
  • 2013-05-16
相关资源
最近更新 更多