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

Les nouvelles menaces liées à l’intelligence artificielle

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

Sommes-nous proches de la singularité technologique ? Peu probable. Même si l’intelligence artificielle a fait un bond ces dernières années (elle est étudiée depuis des dizaines d’années), nous sommes loin d’en perdre le contrôle. Et pourtant, une partie de l’utilisation de l’intelligence artificielle échappe aux analystes. Eh oui ! Comme tout système, elle est utilisée par des acteurs malveillants essayant d’en tirer profit pécuniairement. Cet article met en exergue quelques-unes des applications de l’intelligence artificielle par des acteurs malveillants et décrit succinctement comment parer à leurs attaques.

Migration d’une collection Ansible à l’aide de fqcn_migration

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

Distribuer du contenu Ansible réutilisable (rôle, playbooks) par l’intermédiaire d’une collection est devenu le standard dans l’écosystème de l’outil d’automatisation. Pour éviter tout conflit de noms, ces collections sont caractérisées par un nom unique, formé d’une espace de nom, qui peut-être employé par plusieurs collections (tel qu'ansible ou community) et d’un nom plus spécifique à la fonction de la collection en elle-même. Cependant, il arrive parfois qu’il faille migrer une collection d’un espace de noms à un autre, par exemple une collection personnelle ou communautaire qui passe à un espace de noms plus connus ou certifiés. De même, le nom même de la collection peut être amené à changer, si elle dépasse son périmètre d’origine ou que le produit qu’elle concerne est lui-même renommé.

Mise en place d'Overleaf Community pour l’écriture collaborative au sein de votre équipe

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

Si vous utilisez LaTeX pour vos documents, vous connaissez vraisemblablement Overleaf qui vous permet de rédiger de manière collaborative depuis n’importe quel poste informatique connecté à Internet. Cependant, la version gratuite en ligne souffre de quelques limitations et le stockage de vos projets est externalisé chez l’éditeur du logiciel. Si vous désirez maîtriser vos données et avoir une installation locale de ce bel outil, cet article est fait pour vous.

Abonnez-vous maintenant

et profitez de tous les contenus en illimité

Je découvre les offres

Déjà abonné ? Connectez-vous