phpDocumentor如何为字符串参数提供可用选项的文档

Question

我有一个类的公共方法，我想记录该方法可以接受的可用字符串值。这样做是否可行：

/**
* 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;
}

- Globalz

Answer 1

是的，这样做是可以接受的，但你可以更聪明地做：

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);

当然，如果您是代码的作者，常量的名称可以更短更具描述性。 :)

- OZ_

---

非常感谢，我真的很喜欢使用常量来提供更具描述性和易于记忆的解决方案。 - Globalz