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

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这样的工具会根据这些评论生成文档
2. IDE中的代码完成工具将基于这些注释来了解给定方法所期望的参数，返回的内容等。

检查wiki以获取所有这些文档注释的列表