Added comments to everything

Assets/Scripts/Game/AudioManager.cs

@@ -1,69 +1,113 @@
 using System.Collections.Generic;
-using UnityEngine; using Game; using Music; using Player;
+using UnityEngine;
+using Game;
+using Music;
+using Player;
 
 namespace Music
 {
-
-public class AudioManager : MonoBehaviour
-{
-    public List<SoundEffect> soundEffects = new List<SoundEffect>();
-
-    public static AudioManager Instance;
-
-    private void Awake()
+    /// <summary>
+    /// This class manages the playback of sound effects in the game.
+    /// It provides functionality to play specific sounds by name and ensures a singleton instance for global access.
+    /// </summary>
+    public class AudioManager : MonoBehaviour
     {
-        if (Instance == null)
-        {
-            Instance = this;
-            DontDestroyOnLoad(gameObject);
-        }
-        else
-        {
-            Destroy(gameObject);
-        }
+        /// <summary>
+        /// A list of all sound effects managed by the AudioManager.
+        /// </summary>
+        public List<SoundEffect> soundEffects = new List<SoundEffect>();
 
-        foreach (Transform child in transform)
+        /// <summary>
+        /// The singleton instance of the <see cref="AudioManager"/> class.
+        /// </summary>
+        public static AudioManager Instance;
+
+        /// <summary>
+        /// Initializes the singleton instance and loads all child AudioSources as sound effects.
+        /// </summary>
+        private void Awake()
         {
-            var soundEffect = new SoundEffect(child.name, child.GetComponent<AudioSource>());
-            if (soundEffect != null)
+            // Ensure only one instance of the AudioManager exists
+            if (Instance == null)
             {
-                soundEffects.Add(soundEffect);
+                Instance = this;
+                DontDestroyOnLoad(gameObject); // Persist across scenes
+            }
+            else
+            {
+                Destroy(gameObject); // Destroy duplicate instances
+            }
+
+            // Load all child AudioSources into the soundEffects list
+            foreach (Transform child in transform)
+            {
+                var soundEffect = new SoundEffect(child.name, child.GetComponent<AudioSource>());
+                if (soundEffect != null)
+                {
+                    soundEffects.Add(soundEffect);
+                }
             }
         }
-    }
 
-    public void PlaySound(string soundName)
-    {
-        if (soundName == "Punch")
+        /// <summary>
+        /// Plays a sound effect by its name.
+        /// </summary>
+        /// <param name="soundName">The name of the sound effect to play.</param>
+        /// <remarks>
+        /// If the sound name is "Punch," it plays multiple punch-related sound effects.
+        /// If the sound is not found, a warning is logged to the console.
+        /// </remarks>
+        public void PlaySound(string soundName)
         {
-            soundEffects.Find(x => x.name == "Punch").audioSource.Play();
-            soundEffects.Find(x => x.name == "Punch 2").audioSource.Play();
-            soundEffects.Find(x => x.name == "Punch 3").audioSource.Play();
-
-            return;
-        }
-
-        foreach (var soundEffect in soundEffects)
-        {
-            if (soundEffect.name == soundName)
+            // Special case: Play multiple punch sound effects
+            if (soundName == "Punch")
             {
-                soundEffect.audioSource.Play();
+                soundEffects.Find(x => x.name == "Punch").audioSource.Play();
+                soundEffects.Find(x => x.name == "Punch 2").audioSource.Play();
+                soundEffects.Find(x => x.name == "Punch 3").audioSource.Play();
                 return;
             }
+
+            // Find and play the sound effect by name
+            foreach (var soundEffect in soundEffects)
+            {
+                if (soundEffect.name == soundName)
+                {
+                    soundEffect.audioSource.Play();
+                    return;
+                }
+            }
+
+            // Log a warning if the sound effect is not found
+            Debug.LogWarning($"Sound '{soundName}' not found!");
         }
-        Debug.LogWarning($"Sound '{soundName}' not found!");
     }
-}
 
-public class SoundEffect
-{
-    public string name;
-    public AudioSource audioSource;
-
-    public SoundEffect(string name, AudioSource audioSource)
+    /// <summary>
+    /// Represents a sound effect, including its name and associated AudioSource.
+    /// </summary>
+    public class SoundEffect
     {
-        this.name = name;
-        this.audioSource = audioSource;
+        /// <summary>
+        /// The name of the sound effect.
+        /// </summary>
+        public string name;
+
+        /// <summary>
+        /// The AudioSource component that plays the sound effect.
+        /// </summary>
+        public AudioSource audioSource;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SoundEffect"/> class.
+        /// </summary>
+        /// <param name="name">The name of the sound effect.</param>
+        /// <param name="audioSource">The AudioSource component for the sound effect.</param>
+        public SoundEffect(string name, AudioSource audioSource)
+        {
+            this.name = name;
+            this.audioSource = audioSource;
+        }
     }
 }
-}
+