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)

Contrôler un serveur avec des SMS

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
118
Mois de parution
février 2022
Spécialité(s)
Résumé

Utiliser des SMS pour communiquer avec un serveur peut paraître assez loufoque à notre époque. Pourtant, cela peut être très utile quand l’utilisateur final n’est pas un informaticien et que l’on ne souhaite pas nécessairement développer une application spécifique.

É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

Quarkus : applications Java pour conteneurs

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

Initié par Red Hat, il y a quelques années le projet Quarkus a pris son envol et en est désormais à sa troisième version majeure. Il propose un cadre d’exécution pour une application de Java radicalement différente, où son exécution ultra optimisée en fait un parfait candidat pour le déploiement sur des conteneurs tels que ceux de Docker ou Podman. Quarkus va même encore plus loin, en permettant de transformer l’application Java en un exécutable natif ! Voici une rapide introduction, par la pratique, à cet incroyable framework, qui nous offrira l’opportunité d’illustrer également sa facilité de prise en main.

De la scytale au bit quantique : l’avenir de la cryptographie

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

Imaginez un monde où nos données seraient aussi insaisissables que le célèbre chat de Schrödinger : à la fois sécurisées et non sécurisées jusqu'à ce qu'un cryptographe quantique décide d’y jeter un œil. Cet article nous emmène dans les méandres de la cryptographie quantique, où la physique quantique n'est pas seulement une affaire de laboratoires, mais la clé d'un futur numérique très sécurisé. Entre principes quantiques mystérieux, défis techniques, et applications pratiques, nous allons découvrir comment cette technologie s'apprête à encoder nos données dans une dimension où même les meilleurs cryptographes n’y pourraient rien faire.

Les nouvelles menaces liées à l’intelligence artificielle

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

Sommes-nous proches de la singularité technologique ? Peu probable. Même si l’intelligence artificielle a fait un bond ces dernières années (elle est étudiée depuis des dizaines d’années), nous sommes loin d’en perdre le contrôle. Et pourtant, une partie de l’utilisation de l’intelligence artificielle échappe aux analystes. Eh oui ! Comme tout système, elle est utilisée par des acteurs malveillants essayant d’en tirer profit pécuniairement. Cet article met en exergue quelques-unes des applications de l’intelligence artificielle par des acteurs malveillants et décrit succinctement comment parer à leurs attaques.

Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous