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

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

當然，名稱可以更短，更具描述性的，當你的代碼的作者:)