phpDocumentor如何记录字符串参数的可用选项

| 我有一个用于类的公共方法,我想记录该方法可以接受的可用字符串值。这是否可以接受:
/**
* Set size of photos
* 
* @param string $size can be one of these options: url_sq, url_t, url_s, url_m, url_o
* @return void
*/
public function setSize($size){
    $this->_size = $size;
}
    
已邀请:
        是的,可以接受,但是您可以更聪明地进行操作:
class TheClass
{
 const photo_size_sq = \'url_sq\';
 const photo_size_tiny = \'url_t\';
 const photo_size_small = \'url_s\';
 const photo_size_m = \'url_m\';
 const photo_size_o = \'url_o\';

/**
* Set size of photos
* 
* @param string $size see photo_size_* constants
* @return void
*/
public function setSize($size){
    $this->_size = $size;
}
}
因此,当您调用此函数时,可以使用IDE的自动补全功能,以不将所有值保留在内存中,并确保您键入的代码正确无误:
$object->setSize($object::photo_size_small);
当然,当您编写代码时,常量的名称可以更简短,更具描述性:)     

要回复问题请先登录注册