La documentation de votre projet avec Doxygen

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
69
Mois de parution
novembre 2013
Spécialité(s)


Résumé
La documentation technique d'un code est essentielle pour sa maintenance et sa capacité à évoluer. Cela est vrai pour n'importe quel code, mais plus particulièrement pour les programmes distribués sous licence libre.

Lorsque vous écrivez un programme, vous savez précisément ce que vous faites, pourquoi vous employez tel ou tel algorithme, pourquoi vous avez découpé le code en n classes, etc. Mais toutes ces notions qui vous paraissent évidentes au moment où vous écrivez se révéleront incompréhensibles quelques semaines plus tard ! Et si vous, le concepteur du code, n'êtes même plus capable de comprendre ce que vous avez écrit, qu'en sera-t-il d'un autre développeur ?

Dans la philosophie générale du logiciel libre, vous mettez à disposition du code qui doit pouvoir être lu, corrigé, amélioré et éventuellement servir de « modèle » pour comprendre comment réaliser une opération particulière. Dans ma vision des choses, si vous ne documentez pas votre code, vous ne faites pas du logiciel libre, mais vous surfez sur la vague open source. Un peu comme si vous vendiez des légumes bio tout en consommant des produits transgéniques et en ne recyclant pas vos déchets. Vous...

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

Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous