Doxygen, generateur de documentation de code source pour applications en C, C++, C#, Java, Objective-C, Python, IDL, Fortran, VHDL et PHP (Outil / Generateur de Documentation)
0Donnez une grande plus value à vos commentaires, vos classes, fonctions, procédures, etc. grâce à Doxygen ! Il est beaucoup plus sexy que PhpDocumentor ou PhpXRef.
En clair, Docxygen permet de générer de la documentation depuis votre code source directement et ce sur plusieurs langages. C’est un système de documentation pour C + +, C, Java, Objective-C, Python, IDL (Corba et les saveurs de Microsoft), Fortran, VHDL, PHP et C #. Il peut générer un navigateur de documentation en ligne (au format HTML) et/ou un manuel de référence hors-ligne d’un ensemble de fichiers sources. Il ya aussi un support pour générer la sortie au format RTF, PostScript, PDF, comprimé HTML et les pages de manuel Unix. La documentation est extraite directement à partir des sources, ce qui rend beaucoup plus facile de tenir la documentation a jour et conformément au code source selon les différentes livraisons et l’évolution du projet.
C’est très utile et pratique pour trouver rapidement votre chemin dans les de grosses applications avec des sources importantes. Vous pouvez également visualiser les relations entre les différents éléments : gestion de l’héritage des classes. Il génère également des diagrammes d’héritage et de collaboration, qui sont tous générés automatiquement.
Il a été développé sous Linux et Mac OS X, mais il fonctionne sur la plupart des autres plateformes.
Son utilisation
Son interface propose plusieurs modes de génération. Du simple wizard au mode expert pour aller plus loin dans la personnalisation lors de la génération de la documentation. En fournissant simplement la référence du projet à analyser, un logo, un titre, une description, un emplacement pour la documentation générée, etc.
Veillez bien ensuite à définir le type de langage à analyser :
Enfin procédez à la génération de votre documentation en cliquant sur “Run doxygen” dans l’onglet “Run” puis cliquez sur “Show HTML output” pour parcourir votre documentation toute chaudement générée !
Voici quelques exemples de rendu d’après le CMS WordPress, amusez vous a l’occasion a analyser tout un tas de CMS ou autre cela vous en dira long sur la qualité du developpement ou de l’état d’une application !
