Utiliser un outil de génération de documentation avec Doxygen

Magazine
Marque
Linux Pratique
Numéro
117
|
Mois de parution
janvier 2020
|
Domaines


Résumé

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.


La suite est réservée aux abonnés. Déjà abonné ? Se connecter

Sur le même sujet

Gestion de projets Python avec Pyenv et Pipenv : effet de mode ou solution efficace ?

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
106
|
Mois de parution
janvier 2020
|
Domaines
Résumé

Dans le cadre de développements Python, il y a deux éléments cruciaux : la gestion des environnements virtuels et la gestion des dépendances. Pour cela, il existe deux outils très efficaces : Pyenv et Pip. De plus en plus de développeurs substituent Pipenv à Pip et, en le couplant à Pyenv, présentent cela comme LA solution ultime ! Mais est-ce réellement le cas ?

C++ Moderne : C++17 (partie 2)

Magazine
Marque
GNU/Linux Magazine
Numéro
233
|
Mois de parution
janvier 2020
|
Domaines
Résumé

Dans le précédent article sur C++ 17, nous avons abordé les évolutions du langage et les évolutions de la STL orientées sur les types de bases. Continuons aujourd'hui notre découverte de C++ 17 !

Utiliser un outil de génération de documentation avec Doxygen

Magazine
Marque
Linux Pratique
Numéro
117
|
Mois de parution
janvier 2020
|
Domaines
Résumé

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.

Coder une interface CLI avec des selectbox, des barres de progression, de la complétion… le tout en Python

Magazine
Marque
GNU/Linux Magazine
Numéro
233
|
Mois de parution
janvier 2020
|
Domaines
Résumé

Dans cet article, nous allons découvrir le module Python cleo qui permet de créer des consoles en CLI avec des couleurs, du formatage de texte et de tableaux, des selectbox, des champs de saisie avec complétion et un module de complétion pour bash/zsh, et même fish !

Les bases de la modélisation en UML

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
106
|
Mois de parution
janvier 2020
|
Domaines
Résumé

Ah, l'UML et ses diagrammes qui font fuir certains développeurs, persuadés qu'il s'agit de documents inutiles : j'ai une idée, je code et ça marche… Certes, pour un petit script la technique fonctionne, mais pour un projet de plus grande envergure, il n'est pas inutile de travailler la modélisation !

Par le même auteur

Utiliser un outil de génération de documentation avec Doxygen

Magazine
Marque
Linux Pratique
Numéro
117
|
Mois de parution
janvier 2020
|
Domaines
Résumé

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.