这些注释是做什么用的？ @ param，@ return，@ var，并在Entity的注释中设置

Question

I would like to understand the following annotation that I see in some codes. What is their purpose. (I do understand @Assert and @ORM but not the others which I mentioned in my Title)

here an exemple of code where I saw it.

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

Have read here and there that it s only used for Documentation only. True? or is it like @ORM and @Assert which have a key role in the building of an Application.

Answer 1

This is used only for documentation purposes:

1. Tools like phpDocumentator will generate documetation basing on these comments
2. Code completion tools in your IDE will base on these comments to know what parameters given method expects, what it will return etc.

Check wiki for list of all these doc annotations