@var和多种类型的对象

时间:2014-02-19 06:40:45

标签: phpdoc

引用http://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.var.pkg.html

  

数据类型应该是有效的PHP类型(int,string,bool等),a   对象类型的类名,或简称为“混合”。 phpDocumentor的   将显示未修改的可选描述,默认为   如果数据类型不存在,则为“mixed”

因此,如果该变量应该是Crypt_RSA对象,那么你有@var Crypt_RSA,但是如果它可以是Crypt_RSA对象或Crypt_DSA对象呢?那时你应该说@var mixed吗?似乎在这一点上它有点误导,因为混合,对我来说意味着它支持原语,即使它可能不支持。

有什么想法吗?

谢谢!

1 个答案:

答案 0 :(得分:2)

您可以通过使用管道分隔它们来指示不同的可能返回类型:

/** @var Crypt_RSA|Crypt_DSA a Crypt_* object, of either RSA or DSA subtype */