Co to jest symbol "@" w komentarzach?

Question

W PHP zauważyłem, że ludzie umieszczają symbol "@" w komentarzach kodu źródłowego. Jednym świetnym przykładem jest cokolwiek WordPress. Jeśli spojrzeć na źródła, widzisz rzeczy jak

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

(wp-Db.php, Linia 124)

To zmienia podświetlanie składni w moim edytorze więc jestem zakładając, że coś robi, ale Nie jestem pewien, co robi. Czy ktoś mógłby wyjaśnić, co symbol "@" robi w komentarzach?

Answer 1

To są komentarze PHPDoc. Są one przeznaczone do przetwarzania maszynowego w celu obsługi zautomatyzowanej dokumentacji i zakończenia kodu IDE.

Answer 2

Takie zapisy służą do tworzenia parserów dokumentacji z komentarzy. Pierwszy @ może zostać zidentyfikowany jako wersja, drugi jako argumenty i tak dalej.

Answer 3

Zazwyczaj robi się to automatycznie generując dokumentację z plików z kodem źródłowym. W tym przypadku @_ służą do identyfikacji metadanych dotyczących zmiennej. Zamiast oceniać w kolejności, @var może przekazać analizatorowi dokumentacji, że poniższy tekst opisuje zmienną i tak dalej.

Answer 4

Poprzednie odpowiedzi są poprawne, stwierdzając, że symbole @ w komentarzach źródłowych są komentarzami PHPDoc. Można je dodatkowo wykorzystać do czegoś zwanego "adnotacją", która dodaje metadane do jakiegoś elementu kodu i może wpływać na zachowanie aplikacji. To nie jest oficjalnie wspierane w PHP, ale jest ono przedmiotem dyskusji od kilku lat i jest używane w Symfony, Doctrine i innych projektach.

Doskonałym wyjaśnienie poprzez pokaz slajdów (bez afiliacji ze mną) wszechrzeczy PHP i adnotacji:

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

Ogólny dyskusja na temat adnotacji:

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

An RFC z 2010 r. Dotyczące implementacji adnotacji w PHP:

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