• Najnowsze pytania
  • Bez odpowiedzi
  • Zadaj pytanie
  • Kategorie
  • Tagi
  • Zdobyte punkty
  • Ekipa ninja
  • IRC
  • FAQ
  • Regulamin
  • Książki warte uwagi

Czy ta klasa jest za ok? (C#)

Object Storage Arubacloud
0 głosów
159 wizyt
pytanie zadane 5 lutego 2020 w Nasze projekty przez dawid2002 Mądrala (5,190 p.)

Witam! Ostatnio sobie piszę projekt konsolowy (w języku C#), który polega na tym, że użytkownikowi wyświetla się menu z opcjami. Każda opcja to jakaś mini-gra, bądź opcja wyjścia z programu.

Skoro już mówimy o menu, stworzyłem klasę o nazwie "MainMenu". Poniżej znajduje się kod tej klasy (oraz elementów, które wykorzystuje):

namespace MultiGry
{
    enum OptionsCategory
    {
        NotSelectedYet, Game, Wrong, ExitTheProgram, CanceledExit
    }

    interface IMenuOption
    {
        OptionsCategory OptionExecuting();
        string NameOption { get; }
    }

    class MainMenu
    {
        private int OptionNumber;
        private List<IMenuOption> MenuOptions;

        public MainMenu(List<IMenuOption> menuOptions) =>
            MenuOptions = menuOptions;

        public void ExecutingTheMainMenuOperation()
        {
            OptionsCategory CategoryOfOptionSelected = 0;

            while (CategoryOfOptionSelected != OptionsCategory.ExitTheProgram)
            {
                Console.Clear();
                DisplayingTheMenu();
                CategoryOfOptionSelected = SelectingOption();
            }
        }


        private void DisplayingTheMenu()
        {
            Console.WriteLine("Wybierz jedną z poniższych gier/aplikacji naciskają odpowiedni klawisz:");

            for (int i = 1; i <= MenuOptions.Count; ++i)
                Console.WriteLine(i + ". " + MenuOptions[i - 1].NameOption);
        }

        private OptionsCategory SelectingOption()
        {
            try
            {
                return TryToSelectTheRightOption();
            }
            catch (InvalidOperationException InvalidKeyException)
            {
                Console.WriteLine(InvalidKeyException.Message);
                return OptionsCategory.Wrong;
            }
        }

        private OptionsCategory TryToSelectTheRightOption()
        {
            GetTheOptionNumber();

            if (IsTheNumberOfTheSelectedOptionAppropriate())
            {
                Console.Clear();
                return RunningTheSelectedOption();
            }

            else
                throw new InvalidOperationException("Naciśnięto niewłaściwy klawisz! (dostępne są tylko 1-" + MenuOptions.Count + ")");
        }

        private void GetTheOptionNumber() =>
            OptionNumber = GettingTheKeySelectingByTheUser() - ConsoleKey.D0;

        private ConsoleKey GettingTheKeySelectingByTheUser() =>
            Console.ReadKey().Key;

        private bool IsTheNumberOfTheSelectedOptionAppropriate() =>
            OptionNumber >= 1 && OptionNumber <= MenuOptions.Count;

        /// <return> the last element of the "MenuOptions" list should have the dynamic type "ExitOption" and its "OptionExecuting" method returns 
        /// "OptionsCategory.ExitTheProgram" or "OptionsCategory.CanceledExit". For another dynamic type, "OptionsCategory.Game" should be returned </return>
        private OptionsCategory RunningTheSelectedOption() =>
            MenuOptions[OptionNumber - 1].OptionExecuting();
    }

    // .....
}

W zasadzie mam kilka pytań odnośnie tej klasy:

Czy ta klasa jest za duża (ma 70 linijek, 1 metodę publiczną i 7 prywatnych metod)?

Czy ta klasa narusza zasadę pojedynczej odpowiedzialności?

Jeśli ta klasa jest za duża, to jak ją podzielić logicznie na mniejsze (próbowałem ją już podzielić na klasy, które m.in. wyświetlają samo menu, sprawdzają jaką opcję wybrał użytkownik, itd. ale nie wiedział jak to mądrze zrobić)?

Czy ta klasa wykonuje zbyt dużo operacji?

Jestem osobą, która od niedawna zaczęła przejmować się czystością kodu i nie wiem jak pisać dobry kod, dobre klasy itd. Zatem prosiłbym o nakierowanie mnie jak mógłbym osiągnąć czystość kodu, co trzeba wiedzieć aby pisać dobrze.

PS.

Jeśli mój kod łamie jakieś inne zasady, koncepcje, praktyki programistyczne to byłbym wdzięczny za pokazanie co jest nie tak (choć w szczególności chciałbym odpowiedzi na główny problem). 

Z góry dziękuje za pomoc.

1 odpowiedź

0 głosów
odpowiedź 5 lutego 2020 przez Siemił Mądrala (7,380 p.)
Cześć,

staraj się nie używać tak długich nazw pól czy funkcji. Zamiast 'IsTheNumberOfTheSelectedOptionAppropriate' możesz dać 'ValidateSelectedOption' albo ''CheckSelectedOption', napisz co funkcja robi a nie czym jest.

Bym się nie przejmował ilością linii kodu w klasie. Dodał bym jeszcze klasę z metodami do zarządzania Konsolą. Uniezależnisz się wtedy od Console.

Ps: Pisz testy.
komentarz 7 lutego 2020 przez dawid2002 Mądrala (5,190 p.)
Dzięki!

Podobne pytania

0 głosów
0 odpowiedzi 122 wizyt
pytanie zadane 22 lutego 2020 w C# przez dawid2002 Mądrala (5,190 p.)
0 głosów
1 odpowiedź 166 wizyt
pytanie zadane 11 października 2020 w Java przez zxcvbnm9 Początkujący (260 p.)
0 głosów
3 odpowiedzi 264 wizyt

92,580 zapytań

141,432 odpowiedzi

319,665 komentarzy

61,965 pasjonatów

Motyw:

Akcja Pajacyk

Pajacyk od wielu lat dożywia dzieci. Pomóż klikając w zielony brzuszek na stronie. Dziękujemy! ♡

Oto polecana książka warta uwagi.
Pełną listę książek znajdziesz tutaj.

Akademia Sekuraka

Kolejna edycja największej imprezy hakerskiej w Polsce, czyli Mega Sekurak Hacking Party odbędzie się już 20 maja 2024r. Z tej okazji mamy dla Was kod: pasjamshp - jeżeli wpiszecie go w koszyku, to wówczas otrzymacie 40% zniżki na bilet w wersji standard!

Więcej informacji na temat imprezy znajdziecie tutaj. Dziękujemy ekipie Sekuraka za taką fajną zniżkę dla wszystkich Pasjonatów!

Akademia Sekuraka

Niedawno wystartował dodruk tej świetnej, rozchwytywanej książki (około 940 stron). Mamy dla Was kod: pasja (wpiszcie go w koszyku), dzięki któremu otrzymujemy 10% zniżki - dziękujemy zaprzyjaźnionej ekipie Sekuraka za taki bonus dla Pasjonatów! Książka to pierwszy tom z serii o ITsec, który łagodnie wprowadzi w świat bezpieczeństwa IT każdą osobę - warto, polecamy!

...