phpdoc - 爲方法定義返回對象變量

Question

我一直在尋找這一段時間，要麼我沒有使用正確的搜索條件，或者我失去了一些東西。

我想弄清楚是否可以使用PHPdoc來定義對象返回的變量。

說我有下面的類：現在

class SomeClass { 
    public function staffDetails($id){ 

     $object = new stdClass(); 
     $object->type = "person"; 
     $object->name = "dave"; 
     $object->age = "46";   

     return $object; 
    } 
} 

，這是很容易定義的輸入參數。

/** 
* Get Staff Member Details 
* 
* @param string $id staff id number 
* 
* @return object 
*/ 

class SomeClass { 
    public function staffDetails($id){ 
     $object = new stdClass(); 
     $object->type = "person"; 
     $object->name = "dave"; 
     $object->age = "46";   

     return $object; 
    } 
} 

的問題是，是不是也有類似的事情，用於定義由所討論的方法返回的對象的輸出變量，使其他程序員不必打開這個類和手動查找到的方法，看看有什麼返回對象正在返回？

Answer 1

這裏是4年後，仍然沒有像您最初在問題中描述的那樣註釋stdClass對象的屬性。

收藏已建議在PSR-5，但似乎已經被擊落：https://github.com/php-fig/fig-standards/blob/211063eed7f4d9b4514b728d7b1810d9b3379dd1/proposed/phpdoc.md#collections

似乎只有兩種選擇：

選項1：

創建一個表示數據對象的普通類並註釋這些屬性。

class MyData 
{ 
    /** 
    * This is the name attribute. 
    * @var string 
    */ 
    public $name; 

    /** 
    * This is the age attribute. 
    * @var integer 
    */ 
    public $age; 
} 

選項2：

創建一個通用Struct型類由Gordon的建議，並將其延伸爲您的數據對象使用@property註釋來定義哪些通用的值是可能的__get訪問和__set。

class Struct 
{ 
    /** 
    * Private internal struct attributes 
    * @var array 
    */ 
    private $attributes = []; 

    /** 
    * Set a value 
    * @param string $key 
    * @param mixed $value 
    */ 
    public function __set($key, $value) 
    { 
     $this->attributes[$key] = $value; 
    } 

    /** 
    * Get a value 
    * @param string $key 
    * @return mixed 
    */ 
    public function __get($key) 
    { 
     return isset($this->attributes[$key]) ? $this->attributes[$key] : null; 
    } 

    /** 
    * Check if a key is set 
    * @param string $key 
    * @return boolean 
    */ 
    public function __isset($key) 
    { 
     return isset($this->attributes[$key]) ? true : false; 
    } 
} 

---

/** 
* @property string $name 
* @property integer $age 
*/ 
class MyData extends Struct 
{ 
    // Can optionally add data mutators or utility methods here 
}