Code review exercise, for educational purposes.
revi kòd is an educational project, which will be used for js courses.
Note: the school where the course is given, the HEPL from Liège, Belgium, is a french-speaking school. From this point, the instruction will be in french. Sorry.
Une revue de code est un processus d'examination du code réalisé par d'autres personnes.
Souvent pratiqué au sein d'une même équipe afin d'augmenter ce qu'on appelle la couverture du code, le processus de revue permet de débusquer d'éventuels bugs et/ou problèmes de conception, ainsi que de s'assurer la compréhension du code par tous les membres de l'équipe.
C'est sur ce dernier point que vous allez vous pencher lors de cet exercice, en procédant à la revue du code javascript présent dans ce dépôt github.
Vous avez déjà sûrement fait sans vous en rendre compte un processus de revue de code, en essayant d'analyser et de comprendre le code composé par un ami, collègue ou contributeur ayant partagé du code sur le web.
C'est probablement une des meilleures façons d'apprendre de nouvelles choses.
Ce dépôt contient un fichier html présentant un plugin pour jQuery nommé heplbox, et qui n'est ni plus ni moins qu'une lightbox simplifiée, permettant, au clic sur une image, d'afficher une version en taille réelle dans une fenêtre modale.
Votre mission est de procéder à la revue du fichier js/jquery.heplbox.js.
Le fichier en question contient le code fonctionnel de notre plugin, et, comme vous le remarquerez, il n'est pas commenté.
J'attends de vous que vous analysiez ce code, afin de le comprendre, en saisir le fonctionnement. Imaginez que je n'ai pas codé ce plugin : j'aimerais que vous commentiez le fichier, et m'écriviez un petit descriptif de son fonctionnement.
Lors du prochain cours, chacun devra donc me rendre sa version commentée du fichier js/jquery.heplbox.js, ainsi qu'un document explicatif de son fonctionnement, au format markdown.
Le ton peut être formel, synthétique ou décalé, l'important pour moi étant de voir que vous avez compris le code.
De plus, toute idée (argumentée) pour améliorer le code sera la bienvenue.