From 6051f2a7a664a7a4c5c35ea4b09dcc19e8210e56 Mon Sep 17 00:00:00 2001 From: "nicolas.barbosa" Date: Mon, 13 May 2024 21:47:18 +0200 Subject: [PATCH] Documentations des classes --- Sources/CoreLibrary/Code.cs | 4 ++++ Sources/CoreLibrary/Couleur.cs | 2 +- Sources/CoreLibrary/IRegles.cs | 20 ++++++++-------- Sources/CoreLibrary/Indicateur.cs | 2 +- Sources/CoreLibrary/Jeton.cs | 4 ++-- Sources/CoreLibrary/Joueur.cs | 10 ++++---- Sources/CoreLibrary/Partie.cs | 1 - Sources/CoreLibrary/Plateau.cs | 24 +++++++++---------- Sources/CoreLibrary/ReglesClassiques.cs | 31 ++++++++++++------------- 9 files changed, 50 insertions(+), 48 deletions(-) diff --git a/Sources/CoreLibrary/Code.cs b/Sources/CoreLibrary/Code.cs index 8720ed3..0ff2bc2 100644 --- a/Sources/CoreLibrary/Code.cs +++ b/Sources/CoreLibrary/Code.cs @@ -2,10 +2,14 @@ namespace CoreLibrary { + /// + /// Classe représentant un code, composé des jetons et méthodes + /// public class Code { private readonly Jeton?[] lesJetons; + public int NbJetons { get; private set; } = 0; public Code(int tailleCode) diff --git a/Sources/CoreLibrary/Couleur.cs b/Sources/CoreLibrary/Couleur.cs index ce25820..bbb6900 100644 --- a/Sources/CoreLibrary/Couleur.cs +++ b/Sources/CoreLibrary/Couleur.cs @@ -1,7 +1,7 @@ namespace CoreLibrary { /// - /// Représente les couleurs disponible pour les jetons. + /// Enumération des couleurs disponibles pour les jetons. /// public enum Couleur { diff --git a/Sources/CoreLibrary/IRegles.cs b/Sources/CoreLibrary/IRegles.cs index 8f20344..94c06ea 100644 --- a/Sources/CoreLibrary/IRegles.cs +++ b/Sources/CoreLibrary/IRegles.cs @@ -6,34 +6,34 @@ public interface IRegles { /// - /// Obtient le nom des règles du jeu. + /// Le nom des règles du jeu. /// string Nom { get; } /// - /// Obtient le nombre de maximum de tours. + /// Le nombre de maximum de tours. /// int TourMaximum { get; } /// - /// Obtient la taille maximal du code. + /// La taille maximal du code. /// int TailleCodeMaximum { get; } /// - /// Obtient le nombre de joueurs actuels. + /// Le nombre de joueurs actuels. /// int NbJoueurs { get; } /// - /// Obtient le nombre de maximum de joueurs. + /// Le nombre maximum de joueurs. /// int NbJoueursMaximum { get; } /// - /// Ajoute un joueur avec le nom spécifié. + /// Ajoute un joueur à partir de son nom. /// - /// Nom du joueur à ajouter + /// Nom du joueur à ajouter. /// Le joueur ajouté. Joueur AjouterJoueur(string nom); @@ -55,7 +55,7 @@ Code GenererCode(); /// - /// Initialise le premier joueur à jouer. + /// Démarre la partie. /// void CommencerLaPartie(); @@ -68,13 +68,13 @@ /// /// Récupère les joueurs gagnants. /// - /// Enumération des joueurs gagnants. + /// Les joueurs gagnants. IEnumerable Gagnants(); /// /// Récupère les joueurs perdants. /// - /// Enumération des joueurs perdants. + /// Les joueurs perdants. IEnumerable Perdants(); } } diff --git a/Sources/CoreLibrary/Indicateur.cs b/Sources/CoreLibrary/Indicateur.cs index d26b5da..9dfc91d 100644 --- a/Sources/CoreLibrary/Indicateur.cs +++ b/Sources/CoreLibrary/Indicateur.cs @@ -1,7 +1,7 @@ namespace CoreLibrary { /// - /// Représente les couleurs disponibles pour les indicateurs. + /// Enumération des indicateurs disponibles pour les jetons. /// public enum Indicateur { diff --git a/Sources/CoreLibrary/Jeton.cs b/Sources/CoreLibrary/Jeton.cs index 9940127..226716e 100644 --- a/Sources/CoreLibrary/Jeton.cs +++ b/Sources/CoreLibrary/Jeton.cs @@ -1,12 +1,12 @@ namespace CoreLibrary { /// - /// Représente un jetons de couleur. + /// Structure représentant un jeton de couleur /// public struct Jeton { /// - /// Obtient la couleur du jeton. + /// La couleur du jeton. /// public readonly Couleur Couleur { get; private init; } diff --git a/Sources/CoreLibrary/Joueur.cs b/Sources/CoreLibrary/Joueur.cs index e8463bd..70d6ea8 100644 --- a/Sources/CoreLibrary/Joueur.cs +++ b/Sources/CoreLibrary/Joueur.cs @@ -1,24 +1,24 @@ namespace CoreLibrary { /// - /// Représente un joueur. + /// Classe représentant un joueur. /// public class Joueur { /// - /// Obtient le nom du joueur. + /// Le nom du joueur. /// public string Nom { get; private init; } /// - /// Obtient le plateau du joueur. + /// Le plateau du joueur. /// public Plateau Plateau { get; private init; } /// /// Crée une nouvelle instance de joueur avec un nom et un plateau spécifié. /// - /// Le nom du joueur - /// Le plateau du joueur + /// Le nom du joueur. + /// Le plateau du joueur. public Joueur(string nom, Plateau plateau) { Nom = nom; diff --git a/Sources/CoreLibrary/Partie.cs b/Sources/CoreLibrary/Partie.cs index a6488a6..916e29f 100644 --- a/Sources/CoreLibrary/Partie.cs +++ b/Sources/CoreLibrary/Partie.cs @@ -1,5 +1,4 @@ using CoreLibrary.Events; -using CoreLibrary.Exceptions; namespace CoreLibrary { diff --git a/Sources/CoreLibrary/Plateau.cs b/Sources/CoreLibrary/Plateau.cs index 70ada70..c40dc19 100644 --- a/Sources/CoreLibrary/Plateau.cs +++ b/Sources/CoreLibrary/Plateau.cs @@ -4,7 +4,7 @@ using System.Security.Cryptography; namespace CoreLibrary { /// - /// Représente un plateau de jeu composer de code + /// Classe représentant un plateau de jeu composé de codes et leurs indicateurs ainsi que les méthodes associées. /// public class Plateau { @@ -15,22 +15,22 @@ namespace CoreLibrary private readonly int tailleCode; /// - /// Obtient le numéro de tour actuel. + /// Le numéro de tour actuel. /// public int Tour { get; private set; } = 1; /// - /// Obtient True si le joueur a gagné sinon False + /// La victoire du joueur, True si le joueur a gagné sinon False /// public bool Victoire { get; private set; } = false; /// /// Initialise une nouvelle instance de la classe . /// - /// Taille des codes du plateau - /// Taille du plateau de jeu - /// Levée lorsque la tailleCode est inférieur ou égal à 0. - /// Levée lorsque la tailleGrille est inférieur ou égal à 0. + /// Taille des codes du plateau. + /// Taille du plateau de jeu. + /// Levée lorsque la tailleCode est inférieure ou égale à 0. + /// Levée lorsque la tailleGrille est inférieure ou égale à 0. public Plateau(int tailleCode, int tailleGrille) { if(tailleCode <= 0) @@ -53,7 +53,7 @@ namespace CoreLibrary } /// - /// Génère un code secret aléatoire en utilisant des jetons de couleurs aléatoire. + /// Génère un code secret aléatoire en utilisant des jetons de couleurs aléatoires. /// private void GenererCodeAleatoire() { @@ -75,7 +75,7 @@ namespace CoreLibrary } /// - /// Ajoute le code fourni au plateau de jeu. + /// Ajoute le code fourni au plateau de jeu. /// /// Le code à ajouter au plateau de jeu. /// Levée lorsque le code fourni à une taille invalide. @@ -106,7 +106,7 @@ namespace CoreLibrary /// Vérifie si le code fourni correspond au code secret. /// /// Le code à vérifier. - /// True si le code fourni correspond au code secret, sinon False + /// True si le code fourni correspond au code secret, sinon False /// Levée lorsque le code fourni à une taille invalide. /// Levée lorsque le code fourni est incomplet. public bool EstBonCode(Code code) @@ -142,7 +142,7 @@ namespace CoreLibrary /// /// Récupère le plateau de jeu. /// - /// Le plateau de jeu représenté sous forme d'une collections de jetons. + /// Le plateau de jeu représenté sous forme d'un tableau de tableau de jetons. public IEnumerable> Grille() { IEnumerable[] grilleJetons = new IEnumerable[grille.Length]; @@ -158,7 +158,7 @@ namespace CoreLibrary /// /// Récupère les indicateurs pour chaque tour. /// - /// Les indicateurs pour chaque tour représentés sous forme d'une collections d'indicateurs. + /// Les indicateurs pour chaque tour représentés sous forme d'un tableau de tableau d'indicateurs. public IEnumerable> Indicateurs() { return indicateurs; diff --git a/Sources/CoreLibrary/ReglesClassiques.cs b/Sources/CoreLibrary/ReglesClassiques.cs index 44950b5..541f7f6 100644 --- a/Sources/CoreLibrary/ReglesClassiques.cs +++ b/Sources/CoreLibrary/ReglesClassiques.cs @@ -3,7 +3,7 @@ namespace CoreLibrary { /// - /// Implémente les règles du jeu. + /// Classe définissant les règles classiques du jeu. /// public class ReglesClassiques : IRegles { @@ -12,39 +12,40 @@ namespace CoreLibrary private readonly Joueur[] joueurs; /// - /// Obtient le nom des règles. + /// Le nom des règles. /// public string Nom { get => "Règles classiques"; } /// - /// Obtient le nombre maximum de tours. + /// Le nombre maximum de tour. /// public int TourMaximum { get => 12; } /// - /// Obtient la taille maximale d'un code. + /// La taille maximale d'un code. /// + public int TailleCodeMaximum { get => 4; } /// - /// Obtient le nombre de joueurs actuels dans le jeu. + /// Le nombre de joueurs actuels dans le jeu. /// + public int NbJoueurs { get => nbJoueurs; } /// - /// Obtient le nombre maximum de joueurs possible pour le jeu. + /// Me nombre maximum de joueurs possibles pour le jeu. /// + public int NbJoueursMaximum { get => 2; } /// - /// Initialise une nouvelle instance de la classe en initialisant un tableau de joueurs avec la taille maximale de joueurs autorisée. + /// Initialise une nouvelle instance de la classe /// public ReglesClassiques() { joueurs = new Joueur[NbJoueursMaximum]; } - - /// /// Ajoute un joueur avec le nom spécifié. /// @@ -61,7 +62,7 @@ namespace CoreLibrary /// Obtient le joueur dont c'est actuellement le tour. /// /// Le joueur actuel. - /// Levée lorsqu'il n'y a pas de joueur courant. + /// Levée lorsque la partie n'a pas commencée. public Joueur JoueurCourant() { @@ -74,7 +75,7 @@ namespace CoreLibrary /// /// Passe la main au joueur suivant. /// - /// Levée lorsqu'il n'y a pas de joueur courant. + /// Levée lorsque la partie n'a pas commmencée. public void PasserLaMain() { if (!joueurCourant.HasValue) @@ -91,24 +92,22 @@ namespace CoreLibrary } /// - /// Génère un nouveau code. + /// Génère un nouveau code respectant les règles classiques. /// - /// Le code généré - + /// Le code généré. public Code GenererCode() { return new Code(TailleCodeMaximum); } /// - /// Initialise le premier joueur à jouer. + /// Démarre la partie en décidant que le premier joueur commence. /// public void CommencerLaPartie() { joueurCourant = 0; } - /// /// Vérifie si la partie est terminée. ///