這些註釋是什麼？ @param，@return，@var，並在實體註釋中設置

Question

我想了解我在某些代碼中看到的以下注釋。他們的目的是什麼？ （我明白@Assert和@ORM，但不是我在標題中提到的其他人）

這裏是我看到它的代碼示例。

class Image 
{ 
    /** 
    * Set url // is this line used by any code? Doctrine? 
    * @param string $url // is this line used by any code? Doctrine? 
    * @return Image // is this line used by any code? Doctrine? 
    */ 
    public function setUrl($url){ 
     $this->url=$url; 
     return $this; 
    } 
} 

已經閱讀這裏和那裏，它只用於文檔只。真正？或者它就像是@ORM和@Assert，它們在構建應用程序中起着關鍵作用。

Answer 1

這僅用於文檔目的：

1. 工具，比如phpDocumentator將產生documetation立足於這些意見在你的IDE
2. 代碼完成工具會根據這些意見，以瞭解哪些參數給定的方法預計，它會返回等

檢查wiki所有這些文檔批註的列表