Refactor Code, Comment Code and Finish This Project

Author: Sullivan008

Business.Engine/BusinessEngines/Engines/TeamEngine.cs

@@ -15,22 +15,31 @@ public class TeamEngine : ITeamEngine
     {
         private readonly ITeamRepository _teamRepository;
 
-        public FormulaContext _ctx { get; set; }
+        public FormulaContext ctx { get; set; }
 
         /// <summary>
         ///     Konstruktor
         /// </summary>
         public TeamEngine()
         {
+            /// Repository példányosítása.
             _teamRepository = new TeamRepository();
         }
 
+        /// <summary>
+        ///     Async Method - Metódus, amely a paraméterben átadott TEAM objektumot beszúrja az adatbázisba.
+        /// </summary>
+        /// <param name="team">Az adatbázisba beszúrandó TEAM objektum.</param>
+        /// <returns>TRUE - Ha sikeres volt a beszúrás | FALSE - Ha nem.</returns>
         public async Task<bool> AddTeam(TeamDTO teamDTO)
         {
-            _teamRepository._ctx = _ctx;
+            /// A context objektum átadása a Repository számára.
+            _teamRepository.ctx = ctx;
 
+            /// Az átmappelt objektum beszúrása az adatbázisba.
             Team insertedTeam = await _teamRepository.Add(MapTeamDTOToTeam(teamDTO));
 
+            /// Vizsgálat, hogy jött-e vissza TEAM objektum, és ha igen, akkor annak van-e ID-ja.
             if (insertedTeam != null && insertedTeam?.TeamID != 0)
             {
                 return true;
@@ -39,19 +48,33 @@ public async Task<bool> AddTeam(TeamDTO teamDTO)
             return false;
         }
 
+        /// <summary>
+        ///     Async Method - Metódus, amely lekérdezi az összes TEAM objektumot az adatbázisból.
+        /// </summary>
+        /// <returns>A TEAM objektumokat tartalmazó lista.</returns>
         public async Task<List<TeamDTO>> GetAllTeam()
         {
-            _teamRepository._ctx = _ctx;
+            /// A context objektum átadása a Repository számára.
+            _teamRepository.ctx = ctx;
 
+            /// Az adatbázisból megkapott átmappelt TEAM objektum visszatérítése.
             return MapTeamToTeamDTO((await _teamRepository.GetAllTeam()).ToList());
         }
 
+        /// <summary>
+        ///     Metódus, amely lekérdezi a paraméterben átadott ID-jú TEAM-et az adatbázisóbl.
+        /// </summary>
+        /// <param name="id">A lekérdezendő TEAM ID-ja.</param>
+        /// <returns>Az adatbázisból lekérdezett TEAM objektum.</returns>
         public TeamDTO GetTeamByID(int id)
         {
-            _teamRepository._ctx = _ctx;
+            /// A context objektum átadása a Repository számára.
+            _teamRepository.ctx = ctx;
 
+            /// Az adatbázisból lekérdezett TEAM objektum átmappelése.
             TeamDTO foundTeam = MapTeamToTeamDTO(_teamRepository.GetTeamByID(id).Result);
 
+            /// Vizsgálat, hogy jött-e vissza TEAM objektum, és ha igen, akkor annak van-e ID-ja.
             if (foundTeam != null && foundTeam?.TeamID != 0)
             {
                 return foundTeam;
@@ -62,12 +85,20 @@ public TeamDTO GetTeamByID(int id)
             }
         }
 
+        /// <summary>
+        ///    Async Method - Metódus, amely a paraméterben átadott TEAM objektumot frissíti az adatbázisban.
+        /// </summary>
+        /// <param name="team">A frissítendő TEAM ID-ja.</param>
+        /// <returns>TRUE - Ha sikeres volt a frissítés | FALSE - Ha nem.</returns>
         public async Task<bool> UpdateTeam(TeamDTO teamDTO)
         {
-            _teamRepository._ctx = _ctx;
+            /// A context objektum átadása a Repository számára.
+            _teamRepository.ctx = ctx;
 
+            /// A paraméterben kapott TEAM objektum átmappelése, majd frissítése az adatbázisban.
             Team updatedTeam = await _teamRepository.Update(MapTeamDTOToTeam(teamDTO));
 
+            /// Vizsgálat, hogy jött-e vissza updated objektum a Repositorytól.
             if(updatedTeam != null)
             {
                 return true;
@@ -76,12 +107,21 @@ public async Task<bool> UpdateTeam(TeamDTO teamDTO)
             return false;
         }
 
+        /// <summary>
+        ///     Async Method - Metódus, amely a paraméterben átadott ID-jú TEAM-et kitörli az adatbázisból
+        /// </summary>
+        /// <param name="id">A törelndő TEAM ID-ja.</param>
+        /// <returns>TRUE - Ha sikeres volt a törlés | FALSE - Ha nem.</returns>
         public async Task<bool> DeleteTeamByID(int id)
         {
-            _teamRepository._ctx = _ctx;
+            /// A context objektum átadása a Repository számára.
+            _teamRepository.ctx = ctx;
 
+            /// A paraméterben átadott ID-jú TEAM objektum törlése.
             Team deletedTeam = await _teamRepository.Delete(new Team() { TeamID = id });
 
+            /// Vizsgálat, hogy tartalmaz-e a Repository által visszatérített RRESUlT értéket, és ha igen
+            /// akkor van-e ID érték beállítva neki.
             if(deletedTeam != null && deletedTeam?.TeamID != 0)
             {
                 return true;
@@ -91,10 +131,18 @@ public async Task<bool> DeleteTeamByID(int id)
         }
 
         #region HELPER Methods
+        /// <summary>
+        ///     A paraméterben átadott TEAM objektum listát, átmappeli
+        ///     TEAMDTO objektum Listává.
+        /// </summary>
+        /// <param name="teams">Az átmappelendő TEAM objektum lista</param>
+        /// <returns>A sikeresen átmappelt TEAMDTO Objektum Lista.</returns>
         private List<TeamDTO> MapTeamToTeamDTO(List<Team> teams)
         {
+            /// Objektumokat tartalmazó Lista példányosítása.
             List<TeamDTO> teamDTOs = new List<TeamDTO>();
 
+            /// Az átmappelendő TEAM objektum halmazt bejárva végre hajtjuk a mappelést.
             foreach (Team item in teams)
             {
                 TeamDTO dto = new TeamDTO();
@@ -107,6 +155,11 @@ private List<TeamDTO> MapTeamToTeamDTO(List<Team> teams)
             return teamDTOs;
         }
 
+        /// <summary>
+        ///     A paraméterben átadott TEAMDTO objektumot átmappeli TEAM objektummá.
+        /// </summary>
+        /// <param name="teamDTO">Az átmapelendő TEAMDTO ojbektum.</param>
+        /// <returns>A sikeresen átmappelt Team objektum.</returns>
         private Team MapTeamDTOToTeam(TeamDTO teamDTO)
         {
             Team team = new Team();
@@ -116,6 +169,11 @@ private Team MapTeamDTOToTeam(TeamDTO teamDTO)
             return team;
         }
 
+        /// <summary>
+        ///     A paraméterben átadott TEAM objektumot átmappeli TEAMDTO objektummá.
+        /// </summary>
+        /// <param name="team">Az átmapelendő TEAM ojbektum.</param>
+        /// <returns>A sikeresen átmappelt TeamDTO objektum.</returns>
         private TeamDTO MapTeamToTeamDTO(Team team)
         {
             TeamDTO teamDTO = new TeamDTO();

Business.Engine/BusinessEngines/Engines/UserEngine.cs

@@ -9,24 +9,43 @@ namespace Business.Engine.BusinessEngines.Engines
 {
     public class UserEngine : IUserEngine
     {
+        /// <summary>
+        ///     Async Method - Regisztrál (Azaz lement egy User-t) az adatbázisba, a paraméterben megadott
+        ///     adatok alapján.
+        /// </summary>
+        /// <param name="userManager">A felhasználók kezeléséhez szükséges objektum.</param>
+        /// <param name="userName">A tárolandó felhasználónév</param>
+        /// <param name="password">A tárolandó felhasználónévhez tartozó jelszó.</param>
+        /// <returns>TRUE - Ha sikeres volt a "Regisztráció" | FALSE - Ha nem.</returns>
         public async Task<bool?> Register(UserManager<AppUser> userManager, string userName, string password)
         {
+            /// Lekérdezzük a a User-t a User Name alapján, hogy megtalálhtó-e az adatbázisban.
             AppUser user = await userManager.FindByNameAsync(userName);
 
             try
             {
+                /// Vizsgálat, hogy az eredmény tartalmaz-e értéket, majd annak megfelelően végzünk műveletet.
+                /// NULL - A felhasználó nincs az adatbázisban.
+                /// NotNULL = A felhasználó megtalálható az adatbázisban.
+                /// Catch - Hiba a felhasználó beszúrása során
                 if(user != null)
                 {
                     return false;
                 }
                 else
                 {
-                    user = new AppUser();
-                    user.UserName = userName;
-                    user.Email = $"{userName}@test.com";
+                    /// A beszúrandó AppUser objektum elkészítése.
+                    user = new AppUser
+                    {
+                        UserName = userName,
+                        Email = $"{userName}@test.com"
+                    };
 
+                    /// Az elkészített AppUser objektum és a praméterben kapott Password alapján a felhasználó beszúrása
+                    /// az adatbázisba. (HASH-elt passworddel)
                     IdentityResult result = await userManager.CreateAsync(user, password);
 
+                    /// A beszúrás eredményének vizsgálata, majd annak megfelelően a művelet végrehajtása.
                     if(result.Succeeded)
                     {
                         return true;
@@ -46,11 +65,20 @@ public class UserEngine : IUserEngine
             }
         }
 
+        /// <summary>
+        ///     Async Method - Bejelentkeztet egy felhasználót a Bejelentkezetéshez szükséges API-kat tartalmazó objektumokkal..
+        /// </summary>
+        /// <param name="signInManager">A bejelentkeztetés megvalósításához szükséges objektum.</param>
+        /// <param name="userName">A tárolandó felhasználónév</param>
+        /// <param name="password">A tárolandó felhasználónévhez tartozó jelszó.</param>
+        /// <returns>TRUE - Ha a bejelentkezés sikeresen megvalósult | FALSE - Ha nem.</returns>
         public async Task<bool> Login(SignInManager<AppUser> signInManager, string userName, string password)
         {
+            /// A paraméterben megadott Felhasználónév és Jelszó párossal bejelentkeztet egy felhasználót.
             var result = await signInManager.PasswordSignInAsync(userName, password, false, false);
 
-            if(result.Succeeded)
+            /// A bejelentkezés eredményének vizsgálata, majd annak megfelelően a művelet végrehajtása.
+            if (result.Succeeded)
             {
                 return true;
             }
@@ -59,10 +87,14 @@ public async Task<bool> Login(SignInManager<AppUser> signInManager, string userN
                 return false;
             }
         }
+
+        /// <summary>
+        ///     Async Method - Kiejelentkeztet egy felhasználót a paraméterben átadott szükséges API-kat tartalmazó objektummal..
+        /// </summary>
+        /// <param name="signInManager">A bejelentkeztetés megvalósításához szükséges objektum.</param>
         public async Task Logout(SignInManager<AppUser> signInManager)
         {
             await signInManager.SignOutAsync();
         }
     }
-
 }

Business.Engine/BusinessEngines/Interfaces/ITeamEngine.cs

@@ -1,5 +1,4 @@
-using Business.Entities.DataBaseEntities;
-using Core.Common.Data.DTOs;
+using Core.Common.Data.DTOs;
 using Data.DataAccessLayer.Context;
 using System.Collections.Generic;
 using System.Threading.Tasks;
@@ -8,16 +7,43 @@ namespace Business.Engine.BusinessEngines.Interfaces
 {
     public interface ITeamEngine
     {
-        FormulaContext _ctx { get; set; }
+        /// <summary>
+        ///     A Contextet tartalmazó objektum
+        /// </summary>
+        FormulaContext ctx { get; set; }
 
+        /// <summary>
+        ///     Metódus, amely a paraméterben átadott TEAM objektumot beszúrja az adatbázisba.
+        /// </summary>
+        /// <param name="teamDTO">Az adatbázisba beszúrandó TEAM objektum.</param>
+        /// <returns>TRUE - Ha sikeres volt a beszúrás | FALSE - Ha nem.</returns>
+        Task<bool> AddTeam(TeamDTO teamDTO);
+
+        /// <summary>
+        ///     Metódus, amely lekérdezi az összes TEAM objektumot az adatbázisból.
+        /// </summary>
+        /// <returns>A TEAM objektumokat tartalmazó lista.</returns>
         Task<List<TeamDTO>> GetAllTeam();
 
+        /// <summary>
+        ///     Metódus, amely lekérdezi a paraméterben átadott ID-jú TEAM-et az adatbázisóbl.
+        /// </summary>
+        /// <param name="id">A lekérdezendő TEAM ID-ja.</param>
+        /// <returns>Az adatbázisból lekérdezett TEAM objektum.</returns>
         TeamDTO GetTeamByID(int id);
 
-        Task<bool> AddTeam(TeamDTO team);
-
+        /// <summary>
+        ///     Metódus, amely a paraméterben átadott TEAM objektumot frissíti az adatbázisban.
+        /// </summary>
+        /// <param name="team">A frissítendő TEAM ID-ja.</param>
+        /// <returns>TRUE - Ha sikeres volt a frissítés | FALSE - Ha nem.</returns>
         Task<bool> UpdateTeam(TeamDTO team);
 
+        /// <summary>
+        ///     Metódus, amely a paraméterben átadott ID-jú TEAM-et kitörli az adatbázisból
+        /// </summary>
+        /// <param name="id">A törelndő TEAM ID-ja.</param>
+        /// <returns>TRUE - Ha sikeres volt a törlés | FALSE - Ha nem.</returns>
         Task<bool> DeleteTeamByID(int id);
     }
 }

Business.Engine/BusinessEngines/Interfaces/IUserEngine.cs

@@ -6,10 +6,29 @@ namespace Business.Engine.BusinessEngines.Interfaces
 {
     public interface IUserEngine
     {
+        /// <summary>
+        ///     Regisztrál (Azaz lement egy User-t) az adatbázisba, a paraméterben megadott
+        ///     adatok alapján.
+        /// </summary>
+        /// <param name="userManager">A felhasználók kezeléséhez szükséges objektum.</param>
+        /// <param name="userName">A tárolandó felhasználónév</param>
+        /// <param name="password">A tárolandó felhasználónévhez tartozó jelszó.</param>
+        /// <returns>TRUE - Ha sikeres volt a "Regisztráció" | FALSE - Ha nem.</returns>
         Task<bool?> Register(UserManager<AppUser> userManager, string userName, string password);
 
+        /// <summary>
+        ///     Async Method - Bejelentkeztet egy felhasználót a Bejelentkezetéshez szükséges API-kat tartalmazó objektumokkal..
+        /// </summary>
+        /// <param name="signInManager">A bejelentkeztetés megvalósításához szükséges objektum.</param>
+        /// <param name="userName">A tárolandó felhasználónév</param>
+        /// <param name="password">A tárolandó felhasználónévhez tartozó jelszó.</param>
+        /// <returns>TRUE - Ha a bejelentkezés sikeresen megvalósult | FALSE - Ha nem.</returns>
         Task<bool> Login(SignInManager<AppUser> signInManager, string userName, string password);
 
+        /// <summary>
+        ///     Async Method - Kiejelentkeztet egy felhasználót a paraméterben átadott szükséges API-kat tartalmazó objektummal..
+        /// </summary>
+        /// <param name="signInManager">A bejelentkeztetés megvalósításához szükséges objektum.</param>
         Task Logout(SignInManager<AppUser> signInManager);
     }
 }

Business.Engine/bin/Debug/netcoreapp2.2/Business.Engine.dll

@@ -9,12 +9,12 @@ namespace Core.Common.Utils
     public static class PropertyMapper
     {
         /// <summary>
-        /// Property nevek összemappelése a forrás és a cél között.
+        ///     Property értékek összemappelése a forrás és a cél objektum között.
         /// </summary>
-        /// <typeparam name="T"></typeparam>
-        /// <typeparam name="U"></typeparam>
-        /// <param name="source">The source.</param>
-        /// <param name="destination">The destination.</param>
+        /// <typeparam name="T">A Forrás objektum típusa</typeparam>
+        /// <typeparam name="U">A cél objektum típusa</typeparam>
+        /// <param name="source">A cél objektum</param>
+        /// <param name="destination">A forrás objektum</param>
 
         public static void MapProperties<T, U>(T source, U destination) where T : class, new() where U : class, new()
         {

Business.Engine/bin/Debug/netcoreapp2.2/Business.Engine.pdb

@@ -1,20 +1,25 @@
-using Business.Entities.DataBaseEntities;
-using Data.DataAccessLayer.Context;
+using Data.DataAccessLayer.Context;
 using Microsoft.AspNetCore.Builder;
-using Microsoft.AspNetCore.Identity;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace Core.Deploy.ApplicationDeploy
 {
     public class ApplicationDeploy
     {
+        /// <summary>
+        ///     A DB Migration-t végrehajtó metódus.
+        /// </summary>
+        /// <param name="app">Objektum, amely biztosítja az alkalmazás konfigurálására szolgáló mechanizmusokat.</param>
         public static void DataBaseMigration(IApplicationBuilder app)
         {
+            /// Hozzáférés biztosítása a service csomagokhoz.
             using (var serviceScope = app.ApplicationServices.GetRequiredService<IServiceScopeFactory>().CreateScope())
             {
+                /// Context kiolvasása a service csomagokból.
                 using (FormulaContext context = serviceScope.ServiceProvider.GetService<FormulaContext>())
                 {
+                    /// Migration végrehajtása.
                     context.Database.Migrate();
                 }
             }