Forum d'entraide PHPFrance

Hey ,

Doxygen se présente comme suit :

Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D.

Doxygen est libre et open-source, développé sous licence GNU GPL.

Pour ma part, j'ai essayé plusieurs générateur de documentation API, et je n'ai rien trouvé de mieux. La génération des graphes call et caller via le langage DOT est tout simplement génial. Pareil pour la génération des diagrammes de classes UML. Le tout automatiquement, et via une interface graphique en Java (donc portable), ainsi qu'en ligne de commande.

Ça c'était pour la présentation. Maintenant, la nouvelle est qu'il passe en version 1.5.7. On trouvera son changelog et on pourra le télécharger. On rappelle que les sources sont disponibles, ainsi que les binaires pour les plate-formes les plus courantes (Linux, Mac et Win, dans l'ordre ).


Petit débat intéressant : quel générateur de documentation API utilisez-vous ?

Petit débat intéressant : quel générateur de documentation API utilisez-vous ?

Un générateur de quoi?

Ahhhhhhh je savais bien que j'avais oublié quelque chose...

Merci HyWaN pour cette information très intéressante. Pour moi, j'utilise Netbeans (java) et Visual Studio .Net (vb/c#)

Petit débat intéressant : quel générateur de documentation API utilisez-vous ?

Ben, Word. Pourquoi ?

Microsoft Access génère aussi une doc très complète sur une base de données.

Petit débat intéressant : quel générateur de documentation API utilisez-vous ?

Ben, Word. Pourquoi ?

Hahaha :'D.

Et pour PHP seulement ? Il existe PHPDoc, PHPDocumentor, et d'autres, mais aucun ne m'a plus. Un membre de PHPFrance (modérateur ou ViPHP, je ne me souviens plus) en avait même fait un.

Un membre de PHPFrance (modérateur ou ViPHP, je ne me souviens plus) en avait même fait un.

C'est Naholyr qui avait fait ça il y a quelques années, je ne me souviens plus du nom, mais je devrais pouvoir retrouver ça dans un CD de sauvegarde.

Pour ma part, j'utilise assez volontiers PHPDocumentor. C'est peut-être une question d'habitude, mais je trouve que ça fonctionne plutôt bien pour le besoin que j'ai. Ça exige en revanche de commenter correctement le code et les documentations peuvent alors être très complètes... les graphiques en moins bien entendu.

C'est Naholyr qui avait fait ça il y a quelques années, je ne me souviens plus du nom, mais je devrais pouvoir retrouver ça dans un CD de sauvegarde.

AutoPhpDoc, mais visiblement son site n'est plus dispo: http://naholyr.free.fr/autophpdoc/

Il est téléchargeable ici: http://www.script-webmaster.com/autophp ... vt260.html

Uè, j'avais trouvé le lien depuis ce comparatif sur Developpez.

Sinon, pour répondre à Cyrano, il faut de toute façon beaucoup documenter les codes, que ce soit avec n'importe quel outil.
Le gros avantage de Doxygen c'est vraiment les graphes. On trouve les graphes call, c'est à dire ce que la méthode appelle (et ce que ces autres méthodes appellent). Les graphes caller, c'est à dire où la méthode est appelée. Et enfin la génération des diagrammes de classes selon UML (ou autre, c'est au choix). C'est super puissant, et très pratique.
De plus, Doxygen supporte la syntaxe LaTeX, super pratique pour des algo' un peu galère à expliquer : rien ne vaut une bonne formule de Maths qu'un long discourt.

Hey ,

Une nouvelle version de Doxygen est disponible : 1.5.8. On pourra la télécharger, ou lire le changelog.
Personnellement, je n'ai encore rien trouvé de mieux que Doxygen. Je vous le conseille !