#1 Documenter le code

[Lorène Bergougnoux]

Ticket n°1

Identifiant : 1
Titre : Documenter le code
Personnes en charges : Thomas Marty et Lorène Bergougnoux
Version : MacOs CATALINA, version 10.15.7, Node.js v14.15.1 // macOS Catalina, version 10.15.7, Node.js v12.18.0

Description : L’objectif est de documenter l’ensemble du code pour assurer une compréhension plus rapide et plus efficace.
C’est un travail qui permettra, dans un premier temps, à aider l’ensemble de l’équipe à la correction de bug ultérieurs. Ensuite, il permettra une maintenance bien plus efficace pour une équipe qui découvrira l’ensemble du code plus tard.

Suggestions pour l’implémentation : Utilisation de la syntaxe JavaDoc, de la manière suivante, avant chaque méthode :

/
The HelloWorld program implements an application that
simply displays "Hello World!" to the standard output.

@author Zara Ali
@version 1.0
@since 2014-03-31
*/