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时，您会自动完成建议mytest(test : array)。正如您所看到的，由于上面的PHPDoc，PHPStorm知道$test变量的类型。

Symfony2评论变量和函数

1 个答案: