Documenter du code est souvent une partie d'un projet qui peut paraître longue, fastidieuse, voire ennuyeuse pour certains. Néanmoins, cette étape est cruciale pour la compréhension et la maintenabilité du code. Depuis longtemps, des outils permettant de faciliter cette tâche existent. Cet article a pour but de présenter Doxygen, l'un de ces outils de génération de documentation, et les atouts qu'il peut apporter à ses utilisateurs.
Apparu en 1997, Doxygen est un outil de génération de documentation destiné à de nombreux langages, tels que le C, le C++, le Java, le Python, mais bien plus encore [1]. À l'instar d'outils comme la Javadoc, Doxygen permet de générer automatiquement la documentation d'un code en se basant sur l'analyse de ce dernier à la recherche de balises particulières, comme le ferait un navigateur web avec une page HTML. Si certains de ces termes vous paraissent encore un peu obscurs, pas d'inquiétude ! Nous allons nous attacher dans la suite de cet article à comprendre cet outil, d'abord en présentant en détail ce qu'est la génération de documentation, puis en présentant Doxygen, et les fonctionnalités qu'il propose à ses utilisateurs.
1. La génération de documentation en général
Les outils de génération de documentation sont apparus au milieu des années 90, et se sont rapidement popularisés puis rendus indispensables du fait de leur praticité. Pensés pour...
- 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