如何记录一个需要常量的参数
文档函数或方法参数的建议方法是什么？这些参数的值应该是预定义的常量？ 到目前为止，我使用常量的数据类型，稍后我会添加一些解释。
例如：
<?php
class Foo{
const METHOD_GET = 'get';
const METHOD_POST = 'post';
/**
* Load a new foo
*
* @param string $method HTTP method to use (either Foo::METHOD_GET or Foo::METHOD_POST)
*/
public function load($method=Foo::METHOD_POST){
// ...
}
/**
* Sort current foo
*
* @param int $sort_order Sort order (either SORT_ASC or SORT_DESC)
*/
public function sort($sort_order=SORT_ASC){
// ...
}
}
鉴于您可以使用已知的类作为param和return标签中的dataype，我还希望您可以使用已知的常量。 当您想要指定多个类型选项时，只需使用管道分隔列表。 修改您的示例：
/**
* Load a new foo
*
* @param Foo::METHOD_GET|Foo::METHOD_POST $method HTTP method to use
*/
public function load($method=Foo::METHOD_POST){
// ...
}
由于这种情况下的数据类型是已知的内部类值，它甚至可以在没有类名前缀的情况下工作：
* @param METHOD_GET|METHOD_POST $method HTTP method to use
这里有关于如何使用phpdoc来记录常量的信息
在PHP中，const / define意味着相同
链接地址: http://www.djcxy.com/p/55609.html