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

、定数の名前は、より短く、より記述することができ:)