Bonjour,
C'est la deuxième fois que je me motive pour utiliser phpDocumentor mais comme la
première fois je me heurte à cette interface docBuilder qui refuse de fonctionner du
premier coup.
La première fois je me suis plongé dedans et ça à finit par marcher mais ça m'avait quand
même découragé pas mal.
Est ce que quelqu'un qui connait bien pourrait me dire si je me trompe en disant que ça me semble
pas très pratique ou bien si comme moi vous trouvez qu'il serait possible de faire plus
user friendly?
la communauté d'entraide francophone dédiée au PHP
Est ce que vous aimez l'interface docBuilder de phpDocumentor?
Tu peux considérablement te simplifier la vie en enregistrant les paramètres de configuration dans un fichier en .ini par exemple. Illustration :
Comme tu peux voir, on indique quels fichiers/répertoires, si on doit parser les propriétés/méthodes privées, le chemin vers le répertoire de la doc à générer, etc...
Tu enregistres ce fichier où tu veux sur ta machine et ensuite dans phpDocumentor, tu as sous le lien "Config" un petit formulaire avec "Use a pre-created config file for form values." : inscris le chemin vers le répertoire où tu as enregistré ton fichier de config, chemin du genre C:/mes Documents/phpDocConf/ et cliques sur le bouton [Change] : ça va se recharger en affichant une liste déroulante des fichiers .ini que tu auras stocké. Tu choisis celui de ton choix et il ne te reste ensuite qu'à cliquer en bas à droite sur [Create]
Code : Tout sélectionner
pear=off
filename=C:\www\_Temporaire\Divers\myConfig.php,C:\www\_Temporaire\Divers\myConnexion.php
output=HTML:Smarty:HandS
parseprivate=off
target=C:\www\_Temporaire\Divers\doc
defaultcategoryname=Accès aux Données MySQL
title=myConnexion
sourcecode=on
javadocdesc=onTu enregistres ce fichier où tu veux sur ta machine et ensuite dans phpDocumentor, tu as sous le lien "Config" un petit formulaire avec "Use a pre-created config file for form values." : inscris le chemin vers le répertoire où tu as enregistré ton fichier de config, chemin du genre C:/mes Documents/phpDocConf/ et cliques sur le bouton [Change] : ça va se recharger en affichant une liste déroulante des fichiers .ini que tu auras stocké. Tu choisis celui de ton choix et il ne te reste ensuite qu'à cliquer en bas à droite sur [Create]
Codez en pensant que celui qui maintiendra votre code est un psychopathe qui connait votre adresse 
Merci Cyrano pour ta réponse effectivement c'est beaucoup plus facile comme ça.
Donc au final docBuilder on l'utilise juste pour séléctionner un fichier c'est un peu dommage parce que ça pourrait être bien pratique docBuilder pour tout configurer.
Je dis ça très modestement puisque que je connais pas trop mais je crois avoir identifié deux améliorations qui le rendrait plus facile à utiliser même pour quelqu'un qui ne s'en ait jamais servi:
1.Mettre des messages d'erreur quand on clique sur Create si jamais on a oublié un champ obligatoire
2.Un explorateur pour sélectionner les fichiers et dossiers à parser ainsi que le dossier de sortie.
Je trouve qu'un outil aussi réputé devrait avoir une interface plus attractive un peu comme phpmyadmin pour mysql.
J'ai bien envi de faire ces deux modif dés que j'ai un peu de temps mais je préfère demander avant si vous penser que ça peut être utile et puis deuxième problème j'ai pas encore trouver d'explorateur de fichier qui corresponde vraiment... peut être en faire un juste pour ça c'est pas si compliqué... à voir.
Donc au final docBuilder on l'utilise juste pour séléctionner un fichier c'est un peu dommage parce que ça pourrait être bien pratique docBuilder pour tout configurer.
Je dis ça très modestement puisque que je connais pas trop mais je crois avoir identifié deux améliorations qui le rendrait plus facile à utiliser même pour quelqu'un qui ne s'en ait jamais servi:
1.Mettre des messages d'erreur quand on clique sur Create si jamais on a oublié un champ obligatoire
2.Un explorateur pour sélectionner les fichiers et dossiers à parser ainsi que le dossier de sortie.
Je trouve qu'un outil aussi réputé devrait avoir une interface plus attractive un peu comme phpmyadmin pour mysql.
J'ai bien envi de faire ces deux modif dés que j'ai un peu de temps mais je préfère demander avant si vous penser que ça peut être utile et puis deuxième problème j'ai pas encore trouver d'explorateur de fichier qui corresponde vraiment... peut être en faire un juste pour ça c'est pas si compliqué... à voir.
Les deux modifications que tu suggères sont déjà incluses dedans. Mais il faut indiquer manuellement les chemins. Tu pourrais indiquer les fichiers avec un champ de formulaire de type"file", mais pour les répertoires, c'est une autre paire de manches.
Et accessoirement, phpDocumentor est intégré avec ces options dans Zend Studio avec une interface plus pratique. Mais bon, Zend Studio n'est pas gratuit, pas excessif mais ça reste un outil professionnel.
Et accessoirement, phpDocumentor est intégré avec ces options dans Zend Studio avec une interface plus pratique. Mais bon, Zend Studio n'est pas gratuit, pas excessif mais ça reste un outil professionnel.
Codez en pensant que celui qui maintiendra votre code est un psychopathe qui connait votre adresse
Pour ma part, je me suis fais un petit fichier Shell et ça fonctionne très bien 
. On peut également se faire ses propres fonctions en C, c'est comme on veut (c'est accessible depuis partout si on le place dans /usr/bin par exemple).
Il faut prendre en compte que le DocBuilder n'est qu'une interface graphique, car elle ne lance que des lignes de commandes derrière. Tout ce qu'on fait avec le DocBuilder et faisable en ligne de commande. L'inverse n'est pas forcément vrai ; la ligne de commande étant plus puissante et rapide à mon goût, notamment comme l'a précisé Cyrano, à l'aide d'un fichier .ini.
La ligne de commande les amis, la ligne de commande, c'est tellement bon
.
. On peut également se faire ses propres fonctions en C, c'est comme on veut (c'est accessible depuis partout si on le place dans /usr/bin par exemple).Il faut prendre en compte que le DocBuilder n'est qu'une interface graphique, car elle ne lance que des lignes de commandes derrière. Tout ce qu'on fait avec le DocBuilder et faisable en ligne de commande. L'inverse n'est pas forcément vrai ; la ligne de commande étant plus puissante et rapide à mon goût, notamment comme l'a précisé Cyrano, à l'aide d'un fichier .ini.
La ligne de commande les amis, la ligne de commande, c'est tellement bon
.« Un handicap est le résultat d'une rencontre entre une déficience ou différence et une incapacité de la société à répondre à celle-ci. »
Hoa : http://hoa-project.net (sur @hoaproject).
Hoa : http://hoa-project.net (sur @hoaproject).
Je suis d'accord avec toi Cyrano pour les répertoires c'est la qu'il faudrait trouver un explorateur de fichiers en php qui soit pratique à utiliser, d'ailleurs plus qu'un explorateur (ça je crois qu'il y en a) ce serait plutôt un "sélecteur" de fichier/dossier (comme dans un logiciel quoi).
Pour les messages d'erreur je pensais plus à des messages comme il y a sur les formulaires de certains sites par exemple où tout est présenté sur une seule page et quand on essaye d'envoyer si il y a des erreurs elles s'affichent en rouge à côté du champ comme ça on comprend tout de suite ce qu'on doit faire pour que ça marche.
Je suis d'accord avec toi aussi HyWaN au bout d'un moment on doit éprouver le besoin d'utiliser les lignes de commandes pour bénéficier de toutes les options possibles mais ce que je trouve dommage c'est que quand on commence la première chose qu'on voit de phpDocumentor après l'avoir téléchargé c'est cette interface et elle m'a un peu fait fuir la première fois, maintenant j'ai compris que phpDocumentor est une référence donc j'y revient.
Pour les messages d'erreur je pensais plus à des messages comme il y a sur les formulaires de certains sites par exemple où tout est présenté sur une seule page et quand on essaye d'envoyer si il y a des erreurs elles s'affichent en rouge à côté du champ comme ça on comprend tout de suite ce qu'on doit faire pour que ça marche.
Je suis d'accord avec toi aussi HyWaN au bout d'un moment on doit éprouver le besoin d'utiliser les lignes de commandes pour bénéficier de toutes les options possibles mais ce que je trouve dommage c'est que quand on commence la première chose qu'on voit de phpDocumentor après l'avoir téléchargé c'est cette interface et elle m'a un peu fait fuir la première fois, maintenant j'ai compris que phpDocumentor est une référence donc j'y revient.