Symfony2注釋了以上變量和函數

Question

我開始學習Symfony2時，令我印象深刻的事情之一就是上面對variables和functions的大量注釋，例如：

變量示例：

    /**
 * @var string
 */
private $baseUrl = 'news/';

要么：

/**
 * @var FeedRepository
 */
private $feedRepo;

職能：

/**
 * @param ArticleQuery $query
 * @return QueryBuilder
 */
public function test(){


}

有人可以向我解釋為什么使用這些，為什么這樣做..？

Answer 1

PHPDoc是Javadoc對PHP編程語言的改編。 它仍然是注釋PHP代碼的非正式標准，但是它正在被規范化。 它允許諸如phpDocumentor之類的外部文檔生成器生成API文檔，並幫助某些IDE（例如Zend Studio，NetBeans，JetBrains PhpStorm，ActiveState Komodo Edit和IDE，PHPEdit和Aptana Studio）以松散類型的語言解釋變量類型和其他歧義。提供改進的代碼完成，類型提示和調試。

例如，嘗試使用像PHPStorm這樣的IDE並編寫以下PHP代碼：

/**
 * @param array $test
 */
function mytest($test) {
    // ... nothing here
}

現在，當您開始鍵入myte您將獲得自動myte全，以建議mytest(test : array) 。 如您所見，由於上面的PHPDoc，PHPStorm知道$test變量的類型。