Symfony2 комментирует вышеуказанные переменные и функции

0

Я начал изучать Symfony2. Одна из вещей, которые поразили меня, - это многочисленные комментарии выше variables и functions:

пример переменных:

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

ИЛИ:

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

Функции:

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


}

Может ли кто-нибудь объяснить мне, зачем им пользоваться и зачем делать?

  • 0
    Этот вопрос не имеет отношения к symfony2 . Вы должны удалить ссылки на symfony2 .
  • 0
    Это стандарт PHPDoc. Symfony использует его для определения аннотаций. Он поставляется с кучей полезных инструментов. В примере @ORM или @Assert . google.pl/...
Теги:

1 ответ

5
Лучший ответ

PHPDoc - это адаптация Javadoc для языка программирования PHP. Он по-прежнему является неофициальным стандартом для комментирования кода PHP, но он находится в процессе формализации. Он позволяет внешним генераторам документов, таким как phpDocumentor, создавать документацию по API и помогает некоторым IDE, таким как Zend Studio, NetBeans, JetBrains PhpStorm, ActiveState Komodo Edit и IDE, PHPEdit и Aptana Studio для интерпретации типов переменных и других двусмысленностей на свободно типизированном языке и обеспечить улучшенное завершение кода, тип намека и отладки.

Попробуйте, например, использовать IDE, например PHPStorm, и написать следующий код PHP:

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

Теперь, когда вы начинаете вводить myte вы получаете автозаполнение, чтобы предлагать mytest(test: array). Как вы теперь видите, PHPStorm знает тип переменной $test благодаря вышеописанному PHPDoc.

Поделиться
  • 0
    Спасибо только то, что мне нужно было знать. С уважением

Ещё вопросы

Сообщество Overcoder
Наверх
Меню