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

@@ -9,13 +9,18 @@ import java.util.Set;
import sudoku.core.Console;
/**
* Classe représentant un sudoku.
*/
public class Sudoku {
private final Grille grille;
private final List<Contrainte> contraintes;
private String nom;
/**
* Constructeur permettant d'initialiser un sudoku à partir de la taille de sa grille
* Constructeur permettant d'initialiser un sudoku à partir de la taille de sa
* grille
*
* @param taille : taille de la grille
*/
public Sudoku(int taille) {
@@ -25,18 +30,25 @@ public class Sudoku {
/**
* Méthode permettant de modifier le nom du sudoku, utilisé pour l'affichage.
*
* @param nom : nom du sudoku
*/
public void setNom(String nom) {
this.nom = nom;
}
/**
* Méthode permettant de récupérer le nom du sudoku
*
* @return nom du sudoku
*/
public String getNom() {
return this.nom;
}
/**
* Méthode permettant d'ajouter une contrainte à un sudoku
*
* @param contrainte : contrainte à ajouter
*/
public void ajouterContrainte(Contrainte contrainte) {
@@ -44,7 +56,9 @@ public class Sudoku {
}
/**
* Méthode permettant de vérifier si une case est valide en fonction des contraintes la concernant
* Méthode permettant de vérifier si une case est valide en fonction des
* contraintes la concernant
*
* @param c : case à vérifier
* @return boolean : true si la case est valide, false sinon
*/
@@ -58,7 +72,9 @@ public class Sudoku {
}
/**
* Méthode permettant de vérifier si un sudoku est valide, c'est-à-dire si toutes les cases sont valides.
* Méthode permettant de vérifier si un sudoku est valide, c'est-à-dire si
* toutes les cases sont valides.
*
* @return boolean : true si le sudoku est valide, false sinon
*/
public boolean estValide() {
@@ -73,19 +89,27 @@ public class Sudoku {
return true;
}
/**
* Méthode utilisée pour verifier toute les contraintes lors d'un ajout de Case
* dans la grille.
* @return boolean : true si toutes les contraintes sont respectées, false sinon
*/
public boolean verifierToutesContraintes() {
return grille.verifierToutesContraintes(contraintes);
}
/**
* Méthode permettant de retourner la grille complète
*
* @return Grille
*/
public Grille getGrille() {
return grille;
}
/**
* Méthode du menu principal du jeu.
*/
public static void menu() {
Scanner scanner = new Scanner(System.in);
System.out.println("BIENVENUE DANS LE JEU DE SUDOKU");
@@ -252,6 +276,9 @@ public class Sudoku {
return multidoku;
}
/**
* Méthode du menu principal du jeu de sudoku.
*/
public static void menuGrille() {
Scanner scanner = new Scanner(System.in);
// ETAPE 1 : TAILLE GRILLE
@@ -305,7 +332,8 @@ public class Sudoku {
for (int choixContrainte : contraintesChoisies) {
switch (choixContrainte) {
case 1:
sudoku.ajouterContrainte(new ContrainteBloc(sudoku.getGrille().getTaille(), sudoku.getGrille().getTaille()));
sudoku.ajouterContrainte(
new ContrainteBloc(sudoku.getGrille().getTaille(), sudoku.getGrille().getTaille()));
System.out.println("Contrainte Bloc ajoutée.");
break;
case 2: