PHWinfo banniere

Titres
PORTAIL ANNUAIRE ARTICLES COMPARATEUR HÉBERGEURS DEVIS FORUMS RÉDUCTEUR D'URL
Précédent   PHWinfo > Autres forums > Forum Programmation & Conception > fr.comp.lang.php > Creer une documentation facilement
S'inscrire FAQ Membres Recherche Messages du jour Marquer les forums comme lus
Creer une documentation facilement

Réponse
 
LinkBack Outils de la discussion
Vieux 06/07/2007, 20h13   #1 (permalink)
JF Messian
Aucun Avatar
 
Messages: n/a
Hébergeur:
Par défaut Creer une documentation facilement

Je cherche un moyen de créer facilement une doc sur un applicatif PHP à
partir des commentaires des scripts...

Google ne donne rien...

Une piste ?

--
Un moyen de garde pour vos enfants ?
http://www.easynounou.com
  Réponse avec citation
Vieux 06/07/2007, 23h26   #2 (permalink)
Thierry B.
Aucun Avatar
 
Messages: n/a
Hébergeur:
Par défaut Re: Creer une documentation facilement

--{ JF Messian a plopé ceci: }--

> Je cherche un moyen de créer facilement une doc sur un applicatif PHP à
> partir des commentaires des scripts...
>
> Google ne donne rien...
>


Doxygen ?

--
GNI is not Irix
  Réponse avec citation
Vieux 09/07/2007, 21h33   #3 (permalink)
mala_alorys
Aucun Avatar
 
Messages: n/a
Hébergeur:
Par défaut Re: Creer une documentation facilement

On 7 juil, 00:26, "Thierry B." <t...@prout.stex> wrote:
> --{ JF Messian a plopé ceci: }--
>
> > Je cherche un moyen de créer facilement une doc sur un applicatif PHP à
> > partir des commentaires des scripts...

>
> > Google ne donne rien...

>
> Doxygen ?
>
> --
> GNI is not Irix


En effet, Doxygen est un excellent moyen de créer des documentations à
partir des sources.

http://fr.wikipedia.org/wiki/Doxygen

Cela nécessitera surement une réécriture des commentaires, afin de
rendre leur structure lisible par Doxygen.

Bon courage
  Réponse avec citation
Vieux 10/07/2007, 15h51   #4 (permalink)
Thief13
Aucun Avatar
 
Messages: n/a
Hébergeur:
Par défaut Re: Creer une documentation facilement

JF Messian a écrit :
> Je cherche un moyen de créer facilement une doc sur un applicatif PHP à
> partir des commentaires des scripts...
>
> Google ne donne rien...
>
> Une piste ?
>


Il y a php documentor, qui est tres utilisé, et qui est intégré dans
Zend Studio :
http://www.phpdoc.org/
  Réponse avec citation
Vieux 10/07/2007, 15h51   #5 (permalink)
Christophe Meresse
Aucun Avatar
 
Messages: n/a
Hébergeur:
Par défaut Re: Creer une documentation facilement

On 6 juil, 21:13, messian_nos...@hypermedia-europe.com (JF Messian)
wrote:
> Je cherche un moyen de créer facilement une doc sur un applicatif PHP à
> partir des commentaires des scripts...
>
> Google ne donne rien...


Humm ? "crocodile tapis-volant" ne me donne rien non plus. Par contre
"genereration documentation PHP" me donne en premier résultat un
article qui compare plusieurs outils:

http://cyberzoide.developpez.com/php4/phpdoc/
  Réponse avec citation
Vieux 10/07/2007, 20h34   #6 (permalink)
Denis Beauregard
Aucun Avatar
 
Messages: n/a
Hébergeur:
Par défaut Re: Creer une documentation facilement

Le 06 Jul 2007 19:13:04 GMT, messian_nospam@hypermedia-europe.com (JF
Messian) écrivait dans fr.comp.lang.php:

>Je cherche un moyen de créer facilement une doc sur un applicatif PHP à
>partir des commentaires des scripts...
>
>Google ne donne rien...
>
>Une piste ?


Il y a 20 ans, c'était le sujet de mon mémoire de maîtrise.

Le principal problème, c'est qu'en général, on ne rédige pas les
commentaires dans le but de les relire séparément du code. La
solution est alors de les écrire dans le but de les extraire.

Il suffit alors tout bonnement de marquer les lignes à conserver et
de commenter en conséquence. Par exemple, marquer avec


//# La fonction extrait(x, y) permet d'extraire de la chaine x
//# les occurences y.
//#


Et ensuite, on fait tout bonnement un grep //# *.php ou depuis
DOS, un
for %%c in (*.php) do find "//#" %%c >>doc.txt
(dans un .bat).

Une telle pratique a l'avantage d'être universelle et indépendante
de l'environnement.


Denis
  Réponse avec citation
Réponse


Outils de la discussion

Règles de messages
Vous ne pouvez pas créer de nouvelles discussions
Vous ne pouvez pas envoyer des réponses
Vous ne pouvez pas envoyer des pièces jointes
Vous ne pouvez pas modifier vos messages

Les balises BB sont activées : oui
Les smileys sont activés : oui
La balise [IMG] est activée : oui
Le code HTML peut être employé : non
Trackbacks are oui
Pingbacks are oui
Refbacks are oui


Fuseau horaire GMT +1. Il est actuellement 01h22.


Édité par : vBulletin® version 3.7.2
Copyright ©2000 - 2008, Jelsoft Enterprises Ltd.
Search Engine Friendly URLs by vBSEO 3.2.0 RC5 Tous droits réservés.
Version française #16 par l'association vBulletin francophone
PHWinfo est un site Éducation Sans Frontières
Ad Management by RedTyger
©Tous droits réservés par les parties respectives
Page generated in 0,10583 seconds with 14 queries