Génération automatique de documentation avec Doxygen

Magazine
Marque
GNU/Linux Magazine
Numéro
125
Mois de parution
mars 2010


Résumé
Il vous est sans doute arrivé d'avoir à corriger un code source sans aucune documentation. Vous avez alors éprouvé une rage intense contre le « développeur » dudit code. Lorsqu'il s'agit d'un collègue de travail, vous pourrez toujours trouver un exutoire en allant lui taper dessus (mais pas trop fort quand même). Mais que faire si vous ne connaissez pas la personne responsable de vos maux ? Et comment éviter de vous retrouver dans la situation particulièrement inconfortable du développeur peu consciencieux ? La réponse est dans cet article avec la présentation de Doxygen, un générateur automatique de documentation de code.

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 installer Doxygen, et...

Cet article est réservé aux abonnés. Il vous reste 96% à découvrir.
S'abonner à Connect
  • Accédez à tous les contenus de Connect en illimité
  • Découvrez chaque semaine un nouvel article premium
  • Consultez les nouveaux articles en avant-première
Je m'abonne


Article rédigé par

Par le(s) même(s) auteur(s)

Tester des stratégies d’investissement dans les cryptomonnaies à l’aide d’un bot

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
116
Mois de parution
septembre 2021
Spécialité(s)
Résumé

Les cryptomonnaies ont des cours très volatiles et leur valeur peut s’envoler un jour, pour s’écraser lamentablement le lendemain. Les cours varient très vite, et que l’on souhaite seulement tester des stratégies d’investissement ou même aller jusqu’à acheter des cryptomonnaies, un bot sera forcément un allié de poids.

Créez votre propre blockchain privée

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
116
Mois de parution
septembre 2021
Spécialité(s)
Résumé

Comprendre le fonctionnement des cryptomonnaies en manipulant une blockchain existante est déjà intéressant, mais pour aller plus loin, pouvoir miner et tester sans que cela nous coûte quoi que ce soit, il faut soit utiliser une blockchain publique de test, soit créer notre propre blockchain privée. C’est cette deuxième solution qui est présentée ici.

Les derniers articles Premiums

Les derniers articles Premium

Cryptographie : débuter par la pratique grâce à picoCTF

Magazine
Marque
Contenu Premium
Spécialité(s)
Résumé

L’apprentissage de la cryptographie n’est pas toujours évident lorsqu’on souhaite le faire par la pratique. Lorsque l’on débute, il existe cependant des challenges accessibles qui permettent de découvrir ce monde passionnant sans avoir de connaissances mathématiques approfondies en la matière. C’est le cas de picoCTF, qui propose une série d’épreuves en cryptographie avec une difficulté progressive et à destination des débutants !

Game & Watch : utilisons judicieusement la mémoire

Magazine
Marque
Contenu Premium
Spécialité(s)
Résumé

Au terme de l'article précédent [1] concernant la transformation de la console Nintendo Game & Watch en plateforme de développement, nous nous sommes heurtés à un problème : les 128 Ko de flash intégrés au microcontrôleur STM32 sont une ressource précieuse, car en quantité réduite. Mais heureusement pour nous, le STM32H7B0 dispose d'une mémoire vive de taille conséquente (~ 1,2 Mo) et se trouve être connecté à une flash externe QSPI offrant autant d'espace. Pour pouvoir développer des codes plus étoffés, nous devons apprendre à utiliser ces deux ressources.

Raspberry Pi Pico : PIO, DMA et mémoire flash

Magazine
Marque
Contenu Premium
Spécialité(s)
Résumé

Le microcontrôleur RP2040 équipant la Pico est une petite merveille et malgré l'absence de connectivité wifi ou Bluetooth, l'étendue des fonctionnalités intégrées reste très impressionnante. Nous avons abordé le sujet du sous-système PIO dans un précédent article [1], mais celui-ci n'était qu'une découverte de la fonctionnalité. Il est temps à présent de pousser plus loin nos expérimentations en mêlant plusieurs ressources à notre disposition : PIO, DMA et accès à la flash QSPI.

Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous