Documentation en JS

Il est très important de documenter son code. La norme en JS est JSDoc. C'est similaire à la JavaDoc que vous connaissez déjà. Je vous laisse regarder le site officiel. Vous pouvez vous inspirer du code ci-dessous pour écrire votre documentation. JSdoc permet de générer votre documentation sous la forme d'un site web.

/**
 * Détermine la couleur de l'adversaire en fonction de la couleur du joueur.
 *
 * @param {string} playerColor - La couleur du joueur (B ou W).
 * @returns {string} La couleur de l'adversaire (B ou W).
 * @example
 * const playerColor = Crush.BLACK;
 * const opponentColor = opponent(playerColor);
 * console.log(opponentColor); // Renvoie Crush.WHITE
 */
const opponent = (playerColor) => {
  let opponentColor = playerColor === Crush.BLACK ? Crush.WHITE : Crush.BLACK;
  return opponentColor;
}