La documentation de code ne sert à rien !

Magazine
Marque
GNU/Linux Magazine
Numéro
170
Mois de parution
avril 2014
Spécialité(s)


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.
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)

Et BEM ! Des CSS enfin lisibles !

Magazine
Marque
GNU/Linux Magazine
Numéro
198
Mois de parution
novembre 2016
Spécialité(s)
Résumé

Vous avez déjà lu de longs fichiers de CSS ? Il est assez difficile de s'y retrouver... Pourtant une solution simple existe : adopter des conventions de nommage permettant d'y voir plus clair. Et plutôt que d'inventer sa propre convention, autant essayer d'utiliser ce qui existe déjà.

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

Magazine
Marque
GNU/Linux Magazine
Numéro
197
Mois de parution
octobre 2016
Spécialité(s)
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 !

Les derniers articles Premiums

Les derniers articles Premium

Sécurisez vos applications web : comment Symfony vous protège des menaces courantes

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

Les frameworks tels que Symfony ont bouleversé le développement web en apportant une structure solide et des outils performants. Malgré ces qualités, nous pouvons découvrir d’innombrables vulnérabilités. Cet article met le doigt sur les failles de sécurité les plus fréquentes qui affectent même les environnements les plus robustes. De l’injection de requêtes à distance à l’exécution de scripts malveillants, découvrez comment ces failles peuvent mettre en péril vos applications et, surtout, comment vous en prémunir.

Bash des temps modernes

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

Les scripts Shell, et Bash spécifiquement, demeurent un standard, de facto, de notre industrie. Ils forment un composant primordial de toute distribution Linux, mais c’est aussi un outil de prédilection pour implémenter de nombreuses tâches d’automatisation, en particulier dans le « Cloud », par eux-mêmes ou conjointement à des solutions telles que Ansible. Pour toutes ces raisons et bien d’autres encore, savoir les concevoir de manière robuste et idempotente est crucial.

Présentation de Kafka Connect

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

Un cluster Apache Kafka est déjà, à lui seul, une puissante infrastructure pour faire de l’event streaming… Et si nous pouvions, d’un coup de baguette magique, lui permettre de consommer des informations issues de systèmes de données plus traditionnels, tels que les bases de données ? C’est là qu’intervient Kafka Connect, un autre composant de l’écosystème du projet.

Le combo gagnant de la virtualisation : QEMU et KVM

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

C’est un fait : la virtualisation est partout ! Que ce soit pour la flexibilité des systèmes ou bien leur sécurité, l’adoption de la virtualisation augmente dans toutes les organisations depuis des années. Dans cet article, nous allons nous focaliser sur deux technologies : QEMU et KVM. En combinant les deux, il est possible de créer des environnements de virtualisation très robustes.

Les listes de lecture

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.
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.
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.
Voir les 65 listes de lecture

Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous