Verbesserung von LocalizationController mit XML-Dokumentation

Die Klasse LocalizationController wurde aktualisiert, um XML-Dokumentationskommentare für eine bessere Klarheit und ein besseres Verständnis der Methoden und Eigenschaften einzuschließen. Zusammenfassungen von Konstruktoren und Methoden sowie Parameterbeschreibungen wurden in deutscher Sprache hinzugefügt. Die allgemeine Struktur und Formatierung der Klasse wurde verbessert, um die richtige Definition und Lesbarkeit zu gewährleisten.

EnvelopeGenerator.GeneratorAPI/Controllers/LocalizationController.cs

@@ -6,85 +6,114 @@ using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Caching.Memory;
 using Microsoft.Extensions.Localization;
 
-namespace EnvelopeGenerator.GeneratorAPI.Controllers
+namespace EnvelopeGenerator.GeneratorAPI.Controllers;
+
+/// <summary>
+/// Controller für die Verwaltung der Lokalisierung und Spracheinstellungen.
+/// </summary>
+[Route("api/[controller]")]
+[ApiController]
+public class LocalizationController : ControllerBase
 {
-    [Route("api/[controller]")]
+    private static readonly Guid L_KEY = Guid.NewGuid();
-    [ApiController]
+
-    public class LocalizationController : ControllerBase
+    private readonly ILogger<LocalizationController> _logger;
+    private readonly IStringLocalizer<Model> _mLocalizer;
+    private readonly IStringLocalizer<Resource> _localizer;
+    private readonly IMemoryCache _cache;
+
+    /// <summary>
+    /// Konstruktor für den <see cref="LocalizationController"/>.
+    /// </summary>
+    /// <param name="logger">Logger für die Protokollierung.</param>
+    /// <param name="localizer">Lokalisierungsdienst für Ressourcen.</param>
+    /// <param name="memoryCache">Speicher-Cache für die Zwischenspeicherung von Daten.</param>
+    /// <param name="_modelLocalizer">Lokalisierungsdienst für Modelle.</param>
+    public LocalizationController(
+        ILogger<LocalizationController> logger,
+        IStringLocalizer<Resource> localizer,
+        IMemoryCache memoryCache,
+        IStringLocalizer<Model> _modelLocalizer)
     {
-        private static readonly Guid L_KEY = Guid.NewGuid(); 
+        _logger = logger;
+        _localizer = localizer;
+        _cache = memoryCache;
+        _mLocalizer = _modelLocalizer;
+    }
 
-        private readonly ILogger<LocalizationController> _logger;
+    /// <summary>
-        private readonly IStringLocalizer<Model> _mLocalizer;
+    /// Ruft alle lokalisierten Daten ab.
-        private readonly IStringLocalizer<Resource> _localizer;
+    /// </summary>
-        private readonly IMemoryCache _cache; 
+    /// <returns>Eine Liste aller lokalisierten Daten.</returns>
+    [HttpGet]
+    public IActionResult GetAll() => Ok(_cache.GetOrCreate(Language ?? string.Empty + L_KEY, _ => _mLocalizer.ToDictionary()));
 
-        public LocalizationController(
+    /// <summary>
-            ILogger<LocalizationController> logger,
+    /// Ruft die aktuelle Sprache ab.
-            IStringLocalizer<Resource> localizer,
+    /// </summary>
-            IMemoryCache memoryCache,
+    /// <returns>Die aktuelle Sprache oder ein NotFound-Ergebnis, wenn keine Sprache gesetzt ist.</returns>
-            IStringLocalizer<Model> _modelLocalizer)
+    [HttpGet("lang")]
+    public IActionResult GetLanguage() => Language is null ? NotFound() : Ok(Language);
+
+    /// <summary>
+    /// Setzt die Sprache.
+    /// </summary>
+    /// <param name="language">Die zu setzende Sprache.</param>
+    /// <returns>Ein Ok-Ergebnis, wenn die Sprache erfolgreich gesetzt wurde, oder ein BadRequest-Ergebnis, wenn die Eingabe ungültig ist.</returns>
+    [HttpPost("lang")]
+    public IActionResult SetLanguage([FromQuery] string language)
+    {
+        if (string.IsNullOrEmpty(language))
+            return BadRequest();
+
+        Language = language;
+        return Ok();
+    }
+
+    /// <summary>
+    /// Löscht die aktuelle Sprache.
+    /// </summary>
+    /// <returns>Ein Ok-Ergebnis, wenn die Sprache erfolgreich gelöscht wurde.</returns>
+    [HttpDelete("lang")]
+    public IActionResult DeleteLanguage()
+    {
+        Language = null;
+        return Ok();
+    }
+
+    /// <summary>
+    /// Eigenschaft für die Verwaltung der aktuellen Sprache über Cookies.
+    /// </summary>
+    private string? Language
+    {
+        get
         {
-            _logger = logger;
+            var cookieValue = Request.Cookies[CookieRequestCultureProvider.DefaultCookieName];
-            _localizer = localizer;
+
-            _cache = memoryCache;
+            if (string.IsNullOrEmpty(cookieValue))
-            _mLocalizer = _modelLocalizer;
+                return null;
+
+            var culture = CookieRequestCultureProvider.ParseCookieValue(cookieValue)?.Cultures[0];
+            return culture?.Value ?? null;
         }
-
+        set
-        [HttpGet]
-        public IActionResult GetAll() => Ok(_cache.GetOrCreate(Language ?? string.Empty + L_KEY, _ => _mLocalizer.ToDictionary()));
-
-        [HttpGet("lang")]
-        public IActionResult GetLanguage() => Language is null ? NotFound() : Ok(Language);
-
-        [HttpPost("lang")]
-        public IActionResult SetLanguage([FromQuery] string language)
         {
-            if (string.IsNullOrEmpty(language))
+            if (value is null)
-                return BadRequest();
+                Response.Cookies.Delete(CookieRequestCultureProvider.DefaultCookieName);
-
+            else
-            Language = language;
-            return Ok();
-        }
-
-        [HttpDelete("lang")]
-        public IActionResult DeleteLanguage()
-        {
-            Language = null;
-            return Ok();
-        }
-
-        private string? Language
-        {
-            get
             {
-                var cookieValue = Request.Cookies[CookieRequestCultureProvider.DefaultCookieName];
+                var cookieOptions = new CookieOptions()
-
-                if (string.IsNullOrEmpty(cookieValue))
-                    return null;
-
-                var culture = CookieRequestCultureProvider.ParseCookieValue(cookieValue)?.Cultures[0];
-                return culture?.Value ?? null;
-            }
-            set
-            {
-                if (value is null)
-                    Response.Cookies.Delete(CookieRequestCultureProvider.DefaultCookieName);
-                else
                 {
-                    var cookieOptions = new CookieOptions()
+                    Expires = DateTimeOffset.UtcNow.AddYears(1),
-                    {
+                    Secure = false,
-                        Expires = DateTimeOffset.UtcNow.AddYears(1),
+                    SameSite = SameSiteMode.Strict,
-                        Secure = false,
+                    HttpOnly = true
-                        SameSite = SameSiteMode.Strict,
+                };
-                        HttpOnly = true
-                    };
 
-                    Response.Cookies.Append(
+                Response.Cookies.Append(
-                        CookieRequestCultureProvider.DefaultCookieName,
+                    CookieRequestCultureProvider.DefaultCookieName,
-                        CookieRequestCultureProvider.MakeCookieValue(new RequestCulture(value)),
+                    CookieRequestCultureProvider.MakeCookieValue(new RequestCulture(value)),
-                        cookieOptions);
+                    cookieOptions);
-                }
             }
         }
     }