Что означает символ «@» в комментариях?

Question

В PHP я заметил, что люди помещают символ "@" в комментарии исходного кода. Отличным примером является что-либо WordPress. Когда вы смотрите на источник, вы видите такие вещи, как

/** Results of the last query made
 *
 * @since 1.0.0
 * @access private
 * @var array|null
 */
var $last_result

(wp-db.php, строка 124)

Это меняет подсветку синтаксиса в моем редакторе, поэтому я предполагаю, что он что-то делает, но я не уверен, что он делает. Кто-нибудь объяснит, что символ "@" делает в комментариях?

Answer 1

Это PHPDoc комментариев.Они предназначены для машинного анализа для поддержки автоматической документации и дополнения кода IDE.

Answer 2

Предыдущие ответы верны, если указать, что символы @ в исходных комментариях являются комментариями PHPDoc.Они могут также использоваться для чего-то, называемого «аннотация», который добавляет метаданные к некоторому элементу кода и может влиять на поведение приложения.Официально он не поддерживается в PHP, но обсуждается уже несколько лет и используется в Symfony, Doctrine и других проектах.

Отличное объяснение через слайд-шоу (без связи со мной) всех вещей PHP ианнотация:

http://www.slideshare.net/rdohms/annotations-in-php-they-exist

Общее обсуждение предмета аннотации:

http://en.wikipedia.org/wiki/Annotation

RFC от 2010 года относительно реализации аннотацийв PHP:

http://wiki.php.net/rfc/annotations

Answer 3

Обычно это делается для автоматического создания документации из файлов исходного кода. В этом случае @ _ используются для идентификации метаданных о переменной. Вместо того, чтобы оценивать по порядку, @var может сказать анализатору документации, что следующий текст описывает переменную и т. Д.

Answer 4

Такие обозначения служат способом создания анализатора документации из комментариев.Таким образом, первый @ может быть идентифицирован как версия, второй - как аргументы и т. Д.