这些注释是做什么用的？ @ 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以获取所有这些文档注释的列表