PEAR - PHPDoc

PEAR - PHPDoc - PHP - Programmation

Marsh Posté le 05-01-2005 à 11:50:38    

Bonjour,
 
Il y a quelques temps j'ai decouvert l'existance de PHPDoc sans y accorder une grande  importance.
 
Maintenant je suis entrain de commancer un projet pour mon emplyeur, qui risque de s'etendre sur plusieurs mois, et il y a le risque que moi ou d'autres personnes soyons portés a devoir le modifier dans pas mal de temps. Je me suis donc dit que ca pourrait etre rentable de faire les choses "bien" avec cet instrument.
 
Le probleme est que meme si j'ai cherché un peu partout il y a des questions qui me restent quant a comment programmer exactement le code pour qu'il soit bien lu :  
 
les tag @see , @var ,... doivent etre mis au debut d'une classe/methode ou ils peuvent etre mis juste avant la declaration de la variable. Que mettre si le return de la fonction est une methode ? ...  
 
Par exemple :  
 

Code :
  1. /**
  2. * Ma fonction
  3. *
  4. * @package MonSite
  5. * @param variable $arg Un argument
  6. * @var string $var Date actuelle
  7. * @see MS_mafonction2()
  8. * @return function
  9. */
  11. function MS_mafonction($arg)
  12. {
  13. $var = date();
  14. return MS_mafonction2($arg,$var);
  15. }


 
ou  
 

Code :
  1. /**
  2. * Ma fonction
  3. *
  4. * @package MonSite
  5. * @param variable $arg Un argument
  6. * @return function
  7. */
  9. function mafonction($arg)
  10. {
  11. /**
  12.   * @var string $var Date actuelle
  13.   */
  14. $var = $date();
  15. /**
  16.   * @see mafonction2()
  17.   */
  18. return mafonction2($arg,$var);
  19. }

Reply

Marsh Posté le 05-01-2005 à 11:50:38   

Reply

Marsh Posté le 05-01-2005 à 15:12:57    

Je suis le seul à utiliser PHPDoc?? lol

Reply

Marsh Posté le 05-01-2005 à 15:28:35    

Je savais même pas que ça existait...[:joce]
A priori je mettrais tout au début...:o


---------------
Can't buy what I want because it's free -
Reply

Marsh Posté le 05-01-2005 à 15:30:55    

en théorie après un return, tu y mets ce que tu veux (c'est du texte qui explique ce qui est retourné...)

Reply

Marsh Posté le 05-01-2005 à 15:31:32    

Si ça existe mais il y en a plein d'autre encore.
Je crois que c'est le premier qui est bon.

Reply

Marsh Posté le 05-01-2005 à 15:35:50    

En gros c'est un peu comme une declaration en Java .. Faut tout mettre au debut et apres on se débrouille pour trouver ou ca reviens dans le script ?
 
Et berceker, tu en connais qui sont mieux? Honnetement j'ai pris celui-ci parceque c'est celui qui etais mentionné dans un livre que j'ai lu ... mais s'il y a mieux je veux bien me reconvertir


Message édité par esox_ch le 05-01-2005 à 15:37:35
Reply

Marsh Posté le 05-01-2005 à 15:39:56    

Perso je mets la déclaration avant la fonction, il me semble pas que le générateur rebalance le source dans la doc, le @see n'est donc pas utile dans la fonction. Je présume que quelqu'un qui en est là (dans le code donc) est parfaitement capable de lire les commentaires qui trainent :D

Reply

Marsh Posté le 05-01-2005 à 15:45:55    

Oui justement, je me demandais jusqu'a ou le moteur PHPDoc allais lire ... Donc il lirait uniquement les blocs class{} et  function{} ?

Reply

Sujets relatifs:

Leave a Replay

Make sure you enter the(*)required information where indicate.HTML code is not allowed