12
votes

Quel est le symbole "@" pour dans les commentaires?

en PHP, j'ai remarqué que les gens mettent le symbole "@" dans les commentaires du code source. Un bon exemple est n'importe quoi WordPress. Lorsque vous regardez la source, vous voyez des choses comme xxx

(wp-db.php, ligne 124)

Il modifie la syntaxe en surbrillance dans mon éditeur, donc je ' m en supposant que cela fait quelque chose, mais je ne suis pas sûr de ce que ça fait. Quelqu'un pourrait-il expliquer ce que le symbole "@" fait dans les commentaires?


0 commentaires

4 Réponses :


0
votes

Ces notations servent de manière à créer un analyseur de documentation hors des commentaires. Donc, le premier @ pourrait être identifié comme la version, la seconde que les arguments et ainsi de suite.


0 commentaires

7
votes

Ce sont phpdoc commentaires. Ils sont destinés à être analysables pour prendre en charge la documentation automatisée et l'achèvement du code IDE.


0 commentaires

0
votes

Ceci est typiquement fait pour générer automatiquement une documentation à partir de fichiers de code source. Dans ce cas, les @ _ sont utilisés pour identifier les métadonnées sur la variable. Au lieu d'être évalué dans l'ordre, @Var peut indiquer à l'analyseur de la documentation que le texte suivant décrit la variable et ainsi de suite.


0 commentaires

3
votes

Les réponses précédentes sont correctes pour indiquer que les symboles @ dans les commentaires de la source sont des commentaires phpdoc. Ils peuvent également être utilisés pour quelque chose appelé "Annotation" qui ajoute des métadonnées à un élément de code et peut affecter le comportement d'une application. Il n'est pas officiellement soutenu par PHP, mais cela fait une discussion depuis plusieurs années et est utilisé dans la symfony, la doctrine et d'autres projets.

Une excellente explication par diaporama (aucune affiliation avec moi) de toutes choses PHP et Annotation:

http://www.slideshare.net/rdhemms/annotations- in-php-ils existent

Une discussion générique sur le sujet de l'annotation:

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

Un RFC à partir de 2010 concernant la mise en œuvre d'annotations en PHP:

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


0 commentaires