La documentation de code ne sert à rien !

Magazine
Marque
GNU/Linux Magazine
Numéro
170
Mois de parution
avril 2014
Domaines


Résumé

Le programme est achevé et tout fonctionne correctement... Mission accomplie ! Est-ce vraiment certain ? Des informaticiens s'imposent ou se voient imposer une contrainte aberrante : documenter leur code. Mais pourquoi donc ?


Je vous propose dans cet article un argumentaire imparable pour expliquer à vos collègues pourquoi vous ne documentez pas votre code et pourquoi il s'agit d'une complète perte de temps.

1. Plusieurs types de commentaires

Les concepteurs de langages se sont montrés hésitants lors de l'intégration de la syntaxe permettant de documenter un code : pas moins de trois types de commentaires différents ! L'indécision est flagrante et pour comprendre une telle débauche de syntaxes, il faut faire un petit rappel historique.

La première syntaxe est apparue à la suite d'une soirée fortement arrosée, où quelqu'un s'est dit : « Wouah ! On va ajouter une syntaxe pour insérer des caractères qui ne servent à rien... Ça va être marrant ! ». Cet illustre personnage a méthodiquement...

Cet article est réservé aux abonnés. Il vous reste 90% à découvrir.
à partir de 21,65€ HT/mois/lecteur pour un accès 5 lecteurs à toute la plateforme
J'en profite


Articles qui pourraient vous intéresser...

Les défis de la maintenance logicielle

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
113
Mois de parution
mars 2021
Domaines
Résumé

Maintenir régulièrement et efficacement un logiciel n’est pas une tâche simple. La complexité croissante qui vient avec l’enrichissement de la solution et la multiplication des versions, ainsi que des plateformes d’exécution ajoutent sans cesse à la problématique. Pour y parer, méthode comme outillage adapté sont donc requis.Dans cet article, nous nous proposons de faire un petit tour d’horizon des défis qui caractérisent aujourd’hui la maintenance logicielle.

L’hameçonneur hameçonné

Magazine
Marque
GNU/Linux Magazine
Numéro
246
Mois de parution
mars 2021
Domaines
Résumé

Nous recevons tous régulièrement de nombreux mails de phishing. Ils sont même tellement nombreux que l’on n’y prête plus guère attention. Alors, comment certaines personnes peuvent-elles encore se laisser prendre dans des filets aussi grossiers...