Re: [Dolibarr-dev] PhpDocumentor

[Xavier DUTOIT]

Hello,

J'utilise phpDocumentator, cela marche bien si tu rajoutes des commentaires
dans le code pour, par exemple, expliquer que font les paramètres, si une
méthode est private ou public (cela n'empêche évidemment pas d'appeler une
méthode private depuis l'extérieur, mais au moins, le développeur aura été
informé que c'est pas fait pour).

Sans cela, la doc est déjà pas mal du tout, elle te donne la structure de
tes classes, leur hiérarchie, les variables et fonctions...
Le seul commentaire qui rend la doc beaucoup plus lisible est le package.
C'est un concept logique pour découper le logiciel, pour Doli, il y aurait
par exemple la compta, les contacts, la facturation...
Cela permet de regrouper toutes les classes et fonctions qui sont liées
conceptuellement d'être regroupées dans la doc.
En plus, cela prend deux lignes à rajouter dans le code :
/**
* @package Comptabilite
*/
class Tralala
{...

----- Original Message -----
From: "R. Quiedeville" <address@hidden>
To: <address@hidden>
Sent: Wednesday, August 27, 2003 4:19 PM
Subject: [Dolibarr-dev] PhpDocumentor


> Salut,
>
> Que pensez-vous d'utiliser le package phpDocumentor de PEAR pour la
> doc développeur, l'avez-vous déjà utilisé ?
>
> A++
>
> --
> Rodolphe Quiedeville
>  Artisan Logiciel Libre - http://rodolphe.quiedeville.org/
>       Travaillons Libre - http://fr.lolix.org/
> Réseau Libre Entreprise - http://www.libre-entreprise.com/
>
>
> _______________________________________________
> Dolibarr-dev mailing list
> address@hidden
> http://mail.nongnu.org/mailman/listinfo/dolibarr-dev
>