La documentation de code ne sert à rien !

Magazine
Marque
GNU/Linux Magazine
n°
Numéro
170
Mois de parution
avril 2014
Auteurs
Par
Dr Kiss Cool
Spécialité(s)
Humeur et Critique
Tag(s)
documentation


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…

La suite est réservée aux abonnés. Il vous reste 90% à 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

Dr Kiss Cool
Dr Kiss Cool
10 articles

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

Plus d'article de cet auteur

Logiciel « libre » ou Open Source : finissons-en avec les polémiques !

Magazine
Marque
GNU/Linux Magazine
n°
Numéro
197
Mois de parution
octobre 2016
Auteurs
Par
Dr Kiss Cool
Spécialité(s)
Humeur et Critique
Résumé
Deux clans s'affrontent depuis des années : d'un côté les libristes et de l'autre les tenant de l'Open source. Il est temps de mettre tout ce petit monde d'accord, car il n'y a qu'une vérité et je m'en vais vous l'asséner dans les lignes suivantes !
Lire l'article

Les listes de lecture

Python niveau débutant
9 article(s) - ajoutée le 01/07/2020
Code
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
Algo
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
Code
À 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