doc de code.cs

Sources/CoreLibrary/Code.cs

@@ -3,14 +3,14 @@
 namespace CoreLibrary
 {
     /// <summary>
-    /// Représente un code composé de jetons.
+    /// Classe représentant un code composé de jetons et ses différentes méthodes.
     /// </summary>
     public class Code
     {
         private readonly Jeton?[] lesJetons;
 
         /// <summary>
-        /// Obtenir le nombre de jetons dans le code.
+        /// Le nombre de jetons dans le code.
         /// </summary>
         public int NbJetons { get; private set; } = 0;
 
@@ -51,7 +51,7 @@ namespace CoreLibrary
         /// <summary>
         /// Ajoute un jeton au code.
         /// </summary>
-        /// <param name="jeton">Le jeton à ajouter</param>
+        /// <param name="jeton">Le jeton à ajouter.</param>
         /// <exception cref="CodeCompletException">Levée lorsque le code est plein.</exception>
         public void AjouterJeton(Jeton jeton)
         {
@@ -97,9 +97,9 @@ namespace CoreLibrary
         }
 
         /// <summary>
-        /// Récupère une énumération des jetons dans le code.
+        /// Récupère une liste des jetons dans le code.
         /// </summary>
-        /// <returns>Enumération des jetons du code</returns>
+        /// <returns>Les jetons du code.</returns>
         public IEnumerable<Jeton?> Jetons()
         {
             return lesJetons;
@@ -116,20 +116,19 @@ namespace CoreLibrary
         }
 
         /// <summary>
-        /// Recupère la taille maximal du code.
+        /// Recupère la taille maximale du code.
         /// </summary>
-        /// <returns>Taille maximal du code.</returns>
-
+        /// <returns>Taille maximale du code.</returns>
         public int TailleMaximale()
         {
             return lesJetons.Length;
         }
 
         /// <summary>
-        /// Compare le code avec un autre code et génère des indcateurs de correspondance.
+        /// Compare le code avec un autre code et génère des indicateurs.
         /// </summary>
-        /// <param name="autreCode">Le code à comparer avec le code actuel</param>
-        /// <returns>Enumération d'indicateurs de correspondance entre les deux codes.</returns>
+        /// <param name="autreCode">Le code à comparer avec le code actuel.</param>
+        /// <returns>Les indicateurs de bonne place et bonne couleur entre les deux codes.</returns>
         public IEnumerable<Indicateur> Comparer(Code autreCode)
         {
             // Mon code est le code correct, l'autre code est celui qui teste