Twitter iPhone pliant OnePlus 11 PS5 Disney+ Orange Livebox Windows 11

Creer une documentation facilement

5 réponses
Avatar
messian_nospam
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

5 réponses

Avatar
Thierry B.
--{ 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

Avatar
mala_alorys
On 7 juil, 00:26, "Thierry B." 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 :)


Avatar
Thief13
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/

Avatar
Christophe Meresse
On 6 juil, 21:13, (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/

Avatar
Denis Beauregard
Le 06 Jul 2007 19:13:04 GMT, (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