Documentation regles

master
Pauline PRADY 11 months ago
parent 9ec52a354d
commit 7d9f22147e

@ -1,10 +1,28 @@
namespace CoreLibrary.Regles namespace CoreLibrary.Regles
{ {
/// <summary>
/// Interface pour créer des règles.
/// </summary>
public interface IRegles public interface IRegles
{ {
/// <summary>
/// Obtient le nom des règles.
/// </summary>
string Nom { get; } string Nom { get; }
/// <summary>
/// Obtient le nombre de joueurs.
/// </summary>
int NbJoueurs { get; } int NbJoueurs { get; }
/// <summary>
/// Obtient le nombre de tour.
/// </summary>
int NbTour { get; } int NbTour { get; }
/// <summary>
/// Obtient la taille d'un code.
/// </summary>
int TailleCode { get; } int TailleCode { get; }
} }
} }

@ -2,12 +2,30 @@
namespace CoreLibrary.Regles namespace CoreLibrary.Regles
{ {
/// <summary>
/// Classe pour les règles classiques, implémente IRegles.
/// </summary>
[DataContract] [DataContract]
public class ReglesClassiques : IRegles public class ReglesClassiques : IRegles
{ {
/// <summary>
/// Chaîne de caractères pour le nom des règles classiques.
/// </summary>
public string Nom => "Règles classiques"; public string Nom => "Règles classiques";
/// <summary>
/// Nombre de joueurs autorisé pour les règles classiques.
/// </summary>
public int NbJoueurs => 2; public int NbJoueurs => 2;
/// <summary>
/// Nombre de tour maximum pour des règles classiques.
/// </summary>
public int NbTour => 12; public int NbTour => 12;
/// <summary>
/// Taille du code maximale pour des règles classiques.
/// </summary>
public int TailleCode => 4; public int TailleCode => 4;
} }
} }

Loading…
Cancel
Save