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…

La suite est réservée aux abonnés. Il vous reste 96% à découvrir.
  • 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
Envie de lire la suite ? Rejoignez Connect
Je m'abonne maintenant


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.

Jouons avec le bytecode Python !

Magazine
Marque
GNU/Linux Magazine
Numéro
255
Mois de parution
janvier 2022
Spécialité(s)
Résumé

Comme tout développeur Python le sait (en tout cas, il faut l'espérer), Python est un langage semi-interprété compilé dans un pseudo-code, le bytecode, et exécuté dans une machine virtuelle. Voyons dans cet article comment le modifier à la volée.

Les listes de lecture

Python niveau débutant

9 article(s) - ajoutée le 01/07/2020
Vous désirez apprendre le langage Python, mais ne savez pas trop par où commencer ? Cette liste de lecture vous permettra de faire vos premiers pas en découvrant l'écosystème de Python et en écrivant de petits scripts.

Au pays des algorithmes

11 article(s) - ajoutée le 01/07/2020
La base de tout programme effectuant une tâche un tant soit peu complexe est un algorithme, une méthode permettant de manipuler des données pour obtenir un résultat attendu. Dans cette liste, vous pourrez découvrir quelques spécimens d'algorithmes.

Analyse de données en Python

10 article(s) - ajoutée le 01/07/2020
À quoi bon se targuer de posséder des pétaoctets de données si l'on est incapable d'analyser ces dernières ? Cette liste vous aidera à "faire parler" vos données.
Plus de listes de lecture