refactor: enhance code documentation and remove unnecessary greeting outputs in tests

This commit is contained in:
2025-02-09 15:57:52 +01:00
parent 86fe45c358
commit 7968d5fede
28 changed files with 440 additions and 131 deletions

View File

@@ -4,11 +4,27 @@ import java.util.List;
import sudoku.core.Console;
/**
* Implémentation d'un résolveur de Sudoku utilisant l'algorithme de
* backtracking.
* Cette classe fournit une solution pour résoudre les grilles de Sudoku
* en testant systématiquement toutes les possibilités valides.
*/
public class ResolveurBacktraceSimple implements Resolveur {
/**
* Méthode permettant de résoudre un sudoku en utilisant la méthode de backtracking
* @param s : sudoku à résoudre
* Constructeur par défaut du résolveur backtracking.
* Initialise un nouveau résolveur sans état initial.
*/
public ResolveurBacktraceSimple() {
// Constructeur par défaut
}
/**
* Méthode permettant de résoudre un sudoku en utilisant la méthode de
* backtracking
*
* @param s : sudoku à résoudre
* @param afficherEtape : afficher les étapes de la résolution
* @return true si le sudoku est résolvable, false sinon
*/
@@ -23,10 +39,12 @@ public class ResolveurBacktraceSimple implements Resolveur {
}
/**
* Méthode récursive permettant de résoudre un sudoku, utilisant la méthode de backtracking.
* @param s : sudoku à résoudre
* Méthode récursive permettant de résoudre un sudoku, utilisant la méthode de
* backtracking.
*
* @param s : sudoku à résoudre
* @param afficherEtape : afficher les étapes de la résolution
* @param etat : état de la résolution
* @param etat : état de la résolution
* @return true si le sudoku est résolvable, false sinon
*/
private boolean resoudre(Sudoku s, boolean afficherEtape, EtatResolution etat) {
@@ -60,9 +78,11 @@ public class ResolveurBacktraceSimple implements Resolveur {
/**
* Méthode permettant d'afficher le sudoku à chaque étape de sa résolution
* @param s : sudoku
* @param compteur : compteur de l'étape en cours
* @param compteurGeneral : compteur général de la résolution du sudoku (nombre total de tentatives)
*
* @param s : sudoku
* @param compteur : compteur de l'étape en cours
* @param compteurGeneral : compteur général de la résolution du sudoku (nombre
* total de tentatives)
*/
private void afficherEtapeResolution(Sudoku s, int compteur, int compteurGeneral) {
System.out.println("Sudoku, Etape " + compteur + " (Tentative " + compteurGeneral + ")");
@@ -78,8 +98,10 @@ public class ResolveurBacktraceSimple implements Resolveur {
/**
* Méthode permettant de fixer l'état de la résolution
* @param compteur : compteur de l'étape en cours
* @param compteurGeneral : compteur général de la résolution du sudoku (nombre total de tentatives)
*
* @param compteur : compteur de l'étape en cours
* @param compteurGeneral : compteur général de la résolution du sudoku (nombre
* total de tentatives)
*/
EtatResolution(int compteur, int compteurGeneral) {
this.compteur = compteur;