PHPdoc @param中的两个或多个数据类型

2022-08-30 23:23:10

好的,我确实有这个phpdoc在我的类方法上面

/**
 * this a function that translates the text
 * @param string|boolean $lang if string the string given in the parameter will be the language code that will represent the language desired, if true, this will translate based on the website's current language, if false will not translate.
 */

现在我的问题是,我如何定义只能接受字符串和布尔值的数据类型。$lang

在我看到的其他文档中,但它在我的带有PDT的Eclipse IDE中没有正确反映。mixed

我的问题是,关于如何显示某个人可以接受两种或更多种数据类型的标准方法是什么。@param

注意:我给出的phpdoc是我现在正在使用的应用程序的现有文档。好吧,我被分配来记录好一切。


答案 1

你做对了。PHPDoc 引用为可以是多种数据类型的参数提供了这两个选项(强调我的)。

数据类型应该是有效的PHP类型(int,string,bool等),对象类型的类名,或者只是“混合”。此外,您可以通过用管道分隔单个参数的多个数据类型(例如,“@param int|字符串$p 1”)来列出它们。


答案 2

推荐