Dans tout développement informatique, il est primordial de commenter correctement son code, que ce soit pour vous ou pour d'autres développeurs. En effet, des notions ou algorithmes qui peuvent paraître évidents au moment où vous codez se révéleront particulièrement abscons quelques semaines ou quelques mois plus tard et si vous même n'êtes plus capable de comprendre ce que vous avez écrit, qu'en sera-t-il d'un autre développeur ?
Un générateur automatique de documentation de code ne peut inventer la documentation, il fonctionne en analysant les commentaires des fichiers et en y repérant des commandes particulières. Je vais vous présenter Doxygen [1], l'un de ces générateurs, distribué sous licence GNU GPL. Doxygen permet de générer des documentations aux formats HTM, LaTeX, PDF, PostScript, man, RTF et XML. Il supporte les langages C++, C, Java, Objective-C, Python, IDL, Fortran, VHDL, PHP, C#, et D.
Nous allons commencer par voir comment…
- Accédez à tous les contenus de Connect en illimité
- Découvrez des listes de lecture et des contenus Premium
- Consultez les nouveaux articles en avant-première