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 des listes de lecture et des contenus Premium
  • Consultez les nouveaux articles en avant-première
Je m'abonne


Article rédigé par

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

Édito

Magazine
Marque
GNU/Linux Magazine
Numéro
255
Mois de parution
janvier 2022
Résumé

Dans des temps anciens, les logiciels propriétaires et les logiciels open source se menaient une guerre sévère. Ces temps-là sont désormais révolus. On ne peut pas dire que l’un ou l’autre bord ait gagné, mais en tout cas, il n’existe plus de tension aussi forte entre les partisans des deux camps. On peut se dire que c’est l’open source qui a gagné, qui a finalement été accepté. Mais c’est sans doute oublier un peu vite que l’on peut établir une distinction entre logiciel open source et logiciel libre, le premier profitant de la philosophie du second à des fins purement pécuniaires.

Les derniers articles Premiums

Les derniers articles Premium

Donnez une autre dimension à vos logs avec Vector

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

Avoir des informations précises et détaillées sur ce qu’il se passe dans une infrastructure, et sur les applications qu'elle héberge est un enjeu critique pour votre business. Cependant, ça demande du temps, temps qu'on préfère parfois se réserver pour d'autres tâches jugées plus prioritaires. Mais qu'un système plante, qu'une application perde les pédales ou qu'une faille de sécurité soit découverte et c'est la panique à bord ! Alors je vous le demande, qui voudrait rester aveugle quand l'observabilité a tout à vous offrir ?

Du graphisme dans un terminal ? Oui, avec sixel

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

On le voit de plus en plus, les outils en ligne de commandes s'étoffent peu à peu d'éléments graphiques sous la forme d'émojis UTF8. Plus qu'une simple décoration, cette pointe de « graphisme » dans un monde de texte apporte réellement un plus en termes d'expérience utilisateur et véhicule, de façon condensée, des informations utiles. Pour autant, cette façon de sortir du cadre purement textuel d'un terminal n'est en rien une nouveauté. Pour preuve, fin des années 80 DEC introduisait le VT340 supportant des graphismes en couleurs, et cette compatibilité existe toujours...

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.

Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous