tst

Startcode/game.c

@@ -6,52 +6,66 @@
 #define MAX_RAND_TRIES_PER_WORD 10
 #define EMPTY_CHAR 0
 
+/**
+ * @brief Generiert das Wortsalat-Spielfeld durch zufällige Platzierung von Wörtern.
+ * 
+ * @param salad Das 2D-Array, das das Spielfeld repräsentiert.
+ * @param gridSize Die gewünschte tatsächliche Größe des Rasters (z. B. 20 für 20x20).
+ * @param words Das 2D-Array mit den einzufügenden Wörtern.
+ * @param wordCount Die Anzahl der zu platzierenden Wörter in der Liste.
+ * @return int Die Anzahl der Wörter, die erfolgreich im Raster platziert wurden.
+ */
 int createWordSalad(char salad[MAX_SEARCH_FIELD_LEN][MAX_SEARCH_FIELD_LEN], unsigned int gridSize, char words[][100], unsigned int wordCount)
 {
-    // 1. Spielfeld initialisieren
+    // 1. Spielfeld initialisieren: Kompletten Speicherbereich effizient mit EMPTY_CHAR leeren
     memset(salad, EMPTY_CHAR, MAX_SEARCH_FIELD_LEN * MAX_SEARCH_FIELD_LEN);
 
     int placedWordsCount = 0;
 
-    // 2. Wörter im Spielfeld platzieren
+    // 2. Wörter iterieren und versuchen, sie im Raster zu platzieren
     for (unsigned int i = 0; i < wordCount; i++) {
         int len = (int)strlen(words[i]);
         
-        // Wörter überspringen, die leer oder zu lang für das Suchfeld (gridSize) sind
+        // Ungültige Wörter überspringen (leer oder länger als das Spielfeld)
         if (len == 0 || (unsigned int)len > gridSize) continue;
 
+        // Begrenzte Anzahl an Platzierungsversuchen (verhindert Endlosschleifen bei zu vollem Feld)
         for (int attempt = 0; attempt < MAX_RAND_TRIES_PER_WORD; attempt++) {
+            
+            // Zufällige Richtung wählen: Horizontal oder Vertikal
             Direction dir = (rand() % 2 == 0) ? DIR_HORIZONTAL : DIR_VERTICAL;
             
-            int dr = (dir == DIR_VERTICAL) ? 1 : 0;   // Zeilensprung
+            // Deltas für die Koordinaten berechnen (Verschiebung pro Buchstabe)
-            int dc = (dir == DIR_HORIZONTAL) ? 1 : 0; // Spaltensprung
+            int dr = (dir == DIR_VERTICAL) ? 1 : 0;   // Zeilensprung für vertikale Wörter
+            int dc = (dir == DIR_HORIZONTAL) ? 1 : 0; // Spaltensprung für horizontale Wörter
 
-            // Startkoordinaten innerhalb der gridSize wählen
+            // Startkoordinaten so wählen, dass das Wort garantiert nicht über den Rand ragt
             int row = rand() % (gridSize - (dir == DIR_VERTICAL ? len - 1 : 0));
             int col = rand() % (gridSize - (dir == DIR_HORIZONTAL ? len - 1 : 0));
 
-            // Kollisionsprüfung
+            // Kollisionsprüfung für das gesamte Wort
             int canPlace = 1;
             for (int k = 0; k < len; k++) {
                 char current = salad[row + k * dr][col + k * dc];
+                // Ein Feld ist blockiert, wenn es nicht leer ist UND nicht exakt denselben Buchstaben enthält
                 if (current != EMPTY_CHAR && current != words[i][k]) {
                     canPlace = 0;
                     break;
                 }
             }
 
-            // Wort ins Spielfeld eintragen
+            // Wenn kein Konflikt aufgetreten ist: Wort in das Spielfeld eintragen
             if (canPlace) {
                 for (int k = 0; k < len; k++) {
                     salad[row + k * dr][col + k * dc] = words[i][k];
                 }
                 placedWordsCount++;
-                break;
+                break; // Wort erfolgreich platziert -> Abbruch der Versuchs-Schleife
             }
         }
     }
 
-    // 3. Verbleibende leere Felder innerhalb der gridSize auffüllen
+    // 3. Verbleibende leere Felder innerhalb der sichtbaren gridSize mit zufälligen Großbuchstaben füllen
     for (unsigned int r = 0; r < gridSize; r++) {
         for (unsigned int c = 0; c < gridSize; c++) {
             if (salad[r][c] == EMPTY_CHAR) {