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

Question

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

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

(сор-db.php, линия 124)

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

Answer 1

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

Answer 2

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

Answer 3

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

Answer 4

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

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

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

Родового обсуждение предмета аннотации:

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

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

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