@use, @return @author... c'est quoi ?

[Résolu]
Signaler
Messages postés
198
Date d'inscription
lundi 28 février 2005
Statut
Membre
Dernière intervention
14 novembre 2008
-
Messages postés
198
Date d'inscription
lundi 28 février 2005
Statut
Membre
Dernière intervention
14 novembre 2008
-
Comme le pose la question : dans certains codes du site, je trouve dans les scripts ceci
   @use
   @return
   @author
   @require

C'est quoi extactement ? J'ai fait des rechers sur le web mais je trovue pas ce que c'est !
Merci

5 réponses

Messages postés
10839
Date d'inscription
lundi 24 février 2003
Statut
Modérateur
Dernière intervention
2 mars 2010
23
Hello,

il s'agit d'une convention de nommage pour les commentaires de codes php.
Ils proviennent essentiellement d'un outil opensource qui s'appelle phpdocumentor (enfin...je veux dire que c'est plus ou moins grâce à ce package que cette norme existe).
Messages postés
151
Date d'inscription
samedi 1 novembre 2003
Statut
Membre
Dernière intervention
30 juillet 2018

A noter tout de meme su'il ne faut pas confondre cette norme, avec l'utilisation du @ suivie d'une fonction. dans ce cas du figure, il premet d'eviter le renvoi d'une erreur.

Par exemple, tu fais un include vers une page qui n'existe pas:
# include('page.php');
Cela renverra une erreur du type

Warning: include(page.php) [function.include]: failed to open stream: No such file or directory in C:\Program Files\xampp\htdocs\Untitled-1.php on line 2

Warning: include() [function.include]: Failed opening 'page.php' for inclusion (include_path='.;C:\Program Files\xampp\php\pear\') in C:\Program Files\xampp\htdocs\Untitled-1.php on line 2

avec @function(), l'erreur existera toujours, mais aucun message ne sera renvoyé.
Messages postés
9433
Date d'inscription
mardi 9 octobre 2001
Statut
Membre
Dernière intervention
13 avril 2007
9
Salut,

à noter : ça provient de la javadoc qui utilise cette convention. Lorsque tu renseignes tes méthodes et attributs avec cette convention, java peut te générer une documentation en html automatique.

a +

<hr size="2" width="100%" /><li>Entraide, dépannage et vulgarisation informatique : Mon site de vulgarisation informatique</li>
Messages postés
10839
Date d'inscription
lundi 24 février 2003
Statut
Modérateur
Dernière intervention
2 mars 2010
23
En effet, Antho a raison, au tout départ, cela nous vient de java :-)
Avec le temps, c'est devenu une norme répandue et utilisée par plusieurs générateurs de documentation pour PHP.
Messages postés
198
Date d'inscription
lundi 28 février 2005
Statut
Membre
Dernière intervention
14 novembre 2008
1
merci les gars vous m'avez appeir un nouveau truc dans ma pauvre vie..

aller ciao @@+++ tout le monde !

In PHP We Trust