PHP

PEAR - PHPDoc

Recherche :

Mot : Pseudo : Filtrer
Bas de page
Auteur	Sujet : PEAR - PHPDoc

esox_ch

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 :

/**
* Ma fonction
*
* @package MonSite
* @param variable $arg Un argument
* @var string $var Date actuelle
* @see MS_mafonction2()
* @return function
*/
function MS_mafonction($arg)
{
$var = date();
return MS_mafonction2($arg,$var);
}

Code :

/**
* Ma fonction
*
* @package MonSite
* @param variable $arg Un argument
* @return function
*/
function mafonction($arg)
{
/**
* @var string $var Date actuelle
*/
$var = $date();
/**
* @see mafonction2()
*/
return mafonction2($arg,$var);
}

Publicité

esox_ch

Je suis le seul à utiliser PHPDoc?? lol

skeye

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

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

dreameddeath

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

Berceker United

PSN : berceker_united

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

esox_ch

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

naceroth

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

esox_ch

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

FORUM HardWare.fr

Programmation

PHP

PEAR - PHPDoc

Sujets relatifs
Pear DB tourne avec quelle type de base	Erreur avec librairie Pear
[apache][pear] démarrage difficile	Temporary table avec PEAR DB
Utiliser Pear db sur Free	Problème d'utilisation de PEAR::DB
pear est elle installée chez free.fr ?	Gestion des champs en auto-incrémentation avec PEAR
Meilleur PHPDoc?	Utilisation de pear?
Plus de sujets relatifs à : PEAR - PHPDoc

Page générée en 0.039 secondes