From 7d9f22147eaa41d27a34fa22e0e0808befe44cfe Mon Sep 17 00:00:00 2001 From: "pauline.prady" Date: Tue, 4 Jun 2024 14:04:37 +0200 Subject: [PATCH] Documentation regles --- Sources/CoreLibrary/Regles/IRegles.cs | 18 ++++++++++++++++++ Sources/CoreLibrary/Regles/ReglesClassiques.cs | 18 ++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/Sources/CoreLibrary/Regles/IRegles.cs b/Sources/CoreLibrary/Regles/IRegles.cs index 27ab32e..9bd3825 100644 --- a/Sources/CoreLibrary/Regles/IRegles.cs +++ b/Sources/CoreLibrary/Regles/IRegles.cs @@ -1,10 +1,28 @@ namespace CoreLibrary.Regles { + /// + /// Interface pour créer des règles. + /// public interface IRegles { + /// + /// Obtient le nom des règles. + /// string Nom { get; } + + /// + /// Obtient le nombre de joueurs. + /// int NbJoueurs { get; } + + /// + /// Obtient le nombre de tour. + /// int NbTour { get; } + + /// + /// Obtient la taille d'un code. + /// int TailleCode { get; } } } diff --git a/Sources/CoreLibrary/Regles/ReglesClassiques.cs b/Sources/CoreLibrary/Regles/ReglesClassiques.cs index 6a8723c..c571f64 100644 --- a/Sources/CoreLibrary/Regles/ReglesClassiques.cs +++ b/Sources/CoreLibrary/Regles/ReglesClassiques.cs @@ -2,12 +2,30 @@ namespace CoreLibrary.Regles { + /// + /// Classe pour les règles classiques, implémente IRegles. + /// [DataContract] public class ReglesClassiques : IRegles { + /// + /// Chaîne de caractères pour le nom des règles classiques. + /// public string Nom => "Règles classiques"; + + /// + /// Nombre de joueurs autorisé pour les règles classiques. + /// public int NbJoueurs => 2; + + /// + /// Nombre de tour maximum pour des règles classiques. + /// public int NbTour => 12; + + /// + /// Taille du code maximale pour des règles classiques. + /// public int TailleCode => 4; } }