Que pensez-vous des générateurs de doc PHP ?

[iubito]

j'capte pas ce que tu veux dire par hiérarchisée.

Perso j'commence à utiliser phpdocumentor, je le trouve génial !
Je ne sais pas pour quand est prévue la version suivant (v2) qui devrait apporter énormément de choses... j'ai un peu causé avec Greg, il est bien occupé (il joue dans un quartet et fait des tournées...) et donc il développe en loisir 8)
Il est bien sérieux et corrige vite les bugs (j'en ai débusqué quelques uns )

[Nonothehobbit]

Ben que dès qu'une classe possède des classes filles, un sous-arbe apparaisse, comme ça on voit directement la hiérarchie des classes.

[kileak]

Envoyé par -COil-

J'utilise aussi phpdocumentor , www.phpdoc.org

C'est génial, assez contraignant au debut, mais quand on a fais la base apres c'est facile de mettre a jour voici 2 docs de ma classe de debug avec 2 skins diffentes :

--> http://phpdebug.sourceforge.net/docu...dit/index.html

--> http://phpdebug.sourceforge.net/docu...rty/index.html

J'ai aussi trouvé une doc avec un skin qui de tueur que je vais essayer de recup

--> http://dickmann.homeunix.org/pear/ph.../Var_Dump.html

Au fait c'est un des package officiel de Pear meme s'il peut fonctionner en standalone.

salut

je viens de piger

en fait, ce truc permet de générer dynamiquement ds PHP des sites de documentation ou autres manuels...c'est ça ?

Mais vous devez qd même tout renseigner où ca va choper les champs, titres... dans la Base ?
a+

[debie1108]

A mon avis, rien ne vaut la bonne vieille programmation a la main....

[naholyr]

Je suis le créateur d'AutoPhpDoc. Le projet n'est plus maintenu depuis la dernière version qui date d'un peu plus d'un an, il faut simplement que je le dise sur le site

Le point le plus important de ma démarche était de faire un logiciel utilisable en ligne de commande, sans avoir besoin de faire un script annexe. Si cette fonctionnalité existe sur un autre produit, je suis preneur. Sinon j'essaierai de le reprendre pour qu'il existe quand-même un documenteur qui le permette, quite à simplement écrire une interface CLI à un autre générateur plus suivi (je pense que cette solution est la plus simple).

P.S: pour ceux chez qui l'install a foiré, si vous avez envie de m'envoyer un bug-report je suis preneur

Edit: phpDocumentor s'utilise ultra-facilement en ligne de commande. Je l'ai adopté.

[menkajunan]

Envoyé par cedricgirard

Je voulais juste dire que l'on ne m'a jamais fait entrer dans le crane de force que un bon code est un code commenté.

tu veux dire que vous n'utilisez aucun commentaire pendant la phase de production inclus dans le code ?
et ensuite, une fois le produit définitif livré, aucun commentaire n'est fourni sur le code ?
pourtant, je crois comprendre que vous mettez tout de même une documentation en place.
Quelle est la finalité de celle ci ? le client, le programmeur qui rejoint le projet en cours, les techniciens qui auront en charge la maintenance et l'évolution du projet ?
Celle ci est présentée sous quelle forme ? diagrammes de classes UML, diagrammes de séquence ?

merci de ta réponse

[Kylen]

Pour ceux qui se demande à quoi sert une doc automatique et bien c'est simple: à gonfler un rapport de stage

Enfin je rigole mais ...

[-COil-]

Envoyé par kileak

salut

je viens de piger

en fait, ce truc permet de générer dynamiquement ds PHP des sites de documentation ou autres manuels...c'est ça ?

Mais vous devez qd même tout renseigner où ca va choper les champs, titres... dans la Base ?
a+

Oups !! Desolé pour la réponse tardive !!!

Et bien oui le but est de générer la doc a partir des sources, aussi bien la doc technique que la doc utilisateur, tout se fait à partir des tags inclus dans le source :

Exemple :

--> http://phpdebug.sourceforge.net/docu...debug.php.html

Voici la derniere version de ma doc pour la derniere version de ma classe, elle inclue FAQ, INSTALLATION, contacts, sources des classes, exemples... donc c'est parfait ! Je la met en ligne et je met exactement la meme donc le packake zip de la derniere version de mon package.

--> http://phpdebug.sourceforge.net/docu...1.0/index.html

Vala.

PS : Je n'ai pas testé d'autres générateurs, celui la me convient amplement, et je suis tres loin d'utiliser toutes les possibilités qu'il offre.

[hansaplast]

sur le site de dyoxigen, ils disent que phph n'est pas entieremment supporté, quelles sont les limites stp?

[NiNiX]

Bonjour à tous !

Envoyé par hansaplast

sur le site de dyoxigen, ils disent que phph n'est pas entieremment supporté, quelles sont les limites stp?

Je ne sais pas si c'est une limitation de doxygen par rapport à PHP, mais j'aimerais commenter une variable membre de classe d'une certaine manière, c'est-à-dire, déclarer les variables membres en début de classe sans commentaire, puis avant chaque fonctions accesseurs, créer un bloc de commentaire pour expliquer le rôle de la variable correspondante. Par exemple :

Code :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
class MaClasse
{
    protected $foo;
    protected $bar;
    [...]
 
    public function __construct(){}
    [...]
 
    /**
       \var    $foo
       \brief  Variable permettant de stocker ...
 
                Détail ...
 
       \see   getFoo(), setFoo()
   */
   public function getFoo(){return $this->foo;}
   public function setFoo($foo){$this->foo = foo;}
}

Malheureusement, Doxygen (version 1.4.5) me répond : Warning: documented function 'MaClasse::foo' was not defined (il a du mal avec les $). Apparement beaucoup de personne utilise doxygen pour commenter leur code PHP, et pourtant google ne trouve aucun lien vers ce genre de problème. Je me dis que ca ne doit pas être impossible, et que ca doit être moi qui n'est pas tout compris

J'aimerais donc savoir si quelqu'un sait comment commenter une variable dans un bloc de commentaire indépendant, en utilisant \var (@var) ?

Merci ^^

PS (admin/mod) : Veuillez m'excuser si ce message n'a rien à faire dans ce topic, mais j'ai pas trouvé d'autre endroit où le mettre ^^

[Krieger91]

Bonjour,

j'utilise pour le moment PHPdoc.org et je me retrouve confronté au Problème avec des variables déclarées en public dans mes classes qui n'apparaissent pas dans la doc.

Je viens d'ouvrir un billet sur le forum à cette endroit -> http://www.developpez.net/forums/vie....php?p=2575040

Si des personnes savent la manip à faire pour remonter mes public ça serait super cool...

Cordialement

[stailer]

Personnellement j'utilise PHPDocumentor, intégré dans le Zend Development Environment.
Je le trouve très bien, il permet une foule de format de sortie : html avec des frames, sans frame, avec DOM, du pdf...etc, y a pleins de styles installés.
Personnellement j'utilise le style "phpedit" car il n'inclus pas les codes sources complets mais uniquement la documentation de ses dernières.

[XtofRoland]

http://www.microgold.com/version2/ar...HPReverse.html

je ne l'ai pas utilisé mais ca a l'air interressant

EDIT je l'ai testé, je n'ai pas vu le php dans la version trial et
apres désinstalation j'ai du reinstaller word...

[XtofRoland]

Je suis sous easyphp et j'ai mis phpdocumentator dans un repertoire du root.

la premiere page s'affiche,
a quoi sert la variable :Working Directory?
le bouton ...
me genere une target_blank avec ceci dedans:

Notice: Undefined variable: root_dir in C:\Program Files\Apache Group\Apache2\htdocs\PhpDocumentor-1.3.0RC4\docbuilder\file_dialog.php on line 52

Warning: include_once(/phpDocumentor/common.inc.php) [function.include-once]: failed to open stream: No such file or directory in C:\Program Files\Apache Group\Apache2\htdocs\PhpDocumentor-1.3.0RC4\docbuilder\file_dialog.php on line 52

Warning: ...

Fatal error: Call to undefined function phpDocumentor_parse_ini_file() in C:\Program Files\Apache Group\Apache2\htdocs\PhpDocumentor-1.3.0RC4\docbuilder\file_dialog.php on line 68

Choose a config: je laisse don't use a config

dans Files Directory
to parse je met le repertoire de mon site

dans Output Target je met le chemin du repertoire ou je voudrais que ma doc soit générée.

je click sur create et....
rien...

qqn utilises t'il ce generateur?

EDIT
J'ai réessayé sur un serveur php5 no problemes...
super doc.

[guitou12]

Pour ma part j'utilise doxygen depuis le début, cependant depuis que je suis passé sous Zend pour développer j'ai un petit souci de compatibilité entre les styles de documentation au niveau de la déclaration des variables (balises spéciales Doxygen et phpdoc sous Zend pour un affichage dynamique de bulles d'aide)

Quelqu'un aurait réussi à déjouer ces petits soucis en configurant comme il faut doxygen ?

Voilà la syntaxe que doxygen n'aime pas car il s'attends à une fonction et non une déclaration de membre de classe

Code :

1
2
3
4
5
6
/**
	 * Liste des motifs d'absence
	 *
	 * @var Array $l_motifs
	 */
	private $l_motifs;

[Epoc22]

à tous, j'ai lu entièrement les réponse pour ce sujet et je vous pose une grande question avec un grand problème :
j'ai la dernière version de PhpDocumentor en version stable, je l'ai depuis 1 semaine mais je n'arrive pas du tout à le faire marcher.
Ca m'affiche des messages d'erreur que je ne comprend pas.
Contrairement à ce que certains pourrait le croire, je ne suis pas un newbie.

Je suis depuis 3 mois sur un gros projet et justement il commence vraiment à être très gros et j'ai besoin de documentation (donc d'un générateur).

Et ce que quelqu'un pourrait m'aider ?

EDIT
je pense que j'ai le même problème que XtofRoland.
Je fonctionne sous la dernière version de php 5.

PhpDocumentor me retourne ces erreurs :

ERROR: Converter HTMLSmartyConverter specified by --output command-line option is not a class

ERROR: No Converters have been specified by --output command-line option

ERROR: No Converters have been specified by --output command-line option

[baptistoux]

J'utilise Doxygen pour générer la docmentation de mes développments en C++ ce qui me convient parfaitement.
Cependant j'ai un problème avec ce même outil quand je désire générer la doc pour une application php5; je m'explique :
Doxygen ne me génère la documentation des classes mères, mais pas celle des classes qui en dérive
Quelqu'un aurai rencontré un problème similaire ???

Sinon phpDocumentor génère t-il la documentation en français ?

[Epoc22]

désolé baptistoux, je peut pas t'aider mais les personnes d'en haut le peuvent certainement...
En ce qui concerne PhpDocumentor, la langue de génération dépend de ce que tu écrit dans tes fichiers. Je pense que certains trucs sont en anglais (comme la navigation dans la documentation).

[Baldurien]

Je n'aime plus trop phpDoc.

Pour l'avoir utiliser, je le trouvais sympa au départ, mais assez vite j'ai du m'arrêter de l'utiliser.

D'une part, il n'a pas l'air vraiment bien codé (pour preuve, le tas de notice et warning qu'on trouve dans la ligne de commande quand on a réussi à la faire fonctionner)

D'autre part, le côté ligne de commande assez sporadique et le côté "t'utilises pas PEAR? ben t'as pas phpDoc".

J'ai abandonné phpDoc à la sortie de la 1.3 finale simplement à cause de ça, c'est débile car la doc générée est sympa - malgré que <code> ne fait pas ce qu'il devrait faire (ie: du code en ligne).

Je vais réessayer car, peut-être que le fait d'avoir plusieurs versions n'était pas trop apprécié, mais quand même ...

Quant à Doxygen : sympa dommage que php soit mal supporté :/

[edit] alternativement, il faut savoir que php5 avec l'API de réflection permet de chopper les phpdocs des méthodes, fonctions, et propriétés (ça ne fait pas les constantes, dommage).

[edit] oui donc, après avoir retenté, c'est toujours aussi merdique. la version 1.3 finale refuse carrément de démarrer en ligne de commande sans compter le basar pseudo shell et la jolie erreur du tout début (require_once failed, etc).

Autant la 1.3RC6 fonctionnait, autant là...

[tittoto]

Envoyé par guitou12

Pour ma part j'utilise doxygen depuis le début, cependant depuis que je suis passé sous Zend pour développer j'ai un petit souci de compatibilité entre les styles de documentation au niveau de la déclaration des variables (balises spéciales Doxygen et phpdoc sous Zend pour un affichage dynamique de bulles d'aide)

Quelqu'un aurait réussi à déjouer ces petits soucis en configurant comme il faut doxygen ?

Voilà la syntaxe que doxygen n'aime pas car il s'attends à une fonction et non une déclaration de membre de classe

Code :

Excusez moi de faire remonter le topic, mais je viens de tester qu'aujourd'hui Doxygen et je dois avouer qu'il me plait bien...

Pour ton problème, lit la doc de Doxygen, rubrique

Putting documentation after members
If you want to document the members of a file, struct, union, class, or enum, and you want to put the documentation for these members inside the compound, it is sometimes desired to place the documentation block after the member instead of before. For this purpose you have to put an additional < marker in the comment block. Note that this also works for the parameters of a function.

Here are some examples:

Code :

int var; /*!< Detailed description after the member */

This block can be used to put a Qt style detailed documentation block after a member. Other ways to do the same are:

Code :

int var; /**< Detailed description after the member */

En bref, il faut faire la déclaration juste après ta variable. Exemple:

Code :

1
2
3
4
5
 
    var $usersdb = "";    /**<
	 * the database link for the table USERS
         * @see connect()
	 */

Bonne fin de journée ;-)