Pytanie o styl programowania

Pytanie o styl programowania

Wątek przeniesiony 2020-11-16 09:42 z C/C++ przez cerrato.

didzni
  • Rejestracja:ponad 8 lat
  • Ostatnio:7 miesięcy
  • Postów:133
0

Napisałem program, który owszem, działa. Nie jestem jednak pewien czy jest on dobry od strony stylistycznej. Może robię jakieś karygodne błędy. Nie mam nikogo kto mógłby podpowiedzieć jakie robię błędy albo co robię dobrze. Może piszę w jakimś okropnym stylu? Może "tak się nie robi"?

Kopiuj

#include <iostream>
#include <vector>
#include <chrono>
#include <thread>
#include <algorithm>
#include <random>
#include <time.h>
#include <cstdlib>


unsigned seed = std::chrono::system_clock::now().time_since_epoch().count();
std::default_random_engine gen(seed);

void Tasuj(std::vector<int> & talia)
{
    for (int i=0; i<24; i++) talia.push_back(i % 6);
    std::shuffle(talia.begin(), talia.end(), gen);
}

void Rozdaj(std::vector<int> & talia, std::vector<int>& vec_a, std::vector<int>& vec_b)
{
    for (int i=0; i<12; i++) vec_a.push_back(talia[i]);
    for (int i=12; i<24; i++) vec_b.push_back(talia[i]);
}

void KartaNaStol(std::pair<std::vector<int>, std::vector<int>> & stol, std::vector<int> & vec_A, std::vector<int> & vec_B )
{
    if ((!vec_A.empty()) && (!vec_B.empty())) {
        stol.first.push_back(*(vec_A.end() - 1));
        vec_A.pop_back();
        stol.second.push_back(*(vec_B.end() - 1));
        vec_B.pop_back();
    }
}

void Przeloz(std::pair<std::vector<int>, std::vector<int>> & stol,std::vector<int> & vec, int ktowygral)
{
    if (ktowygral)
    {
        while (!stol.first.empty())
        {
            vec.insert(vec.begin(), stol.first[0]);
            stol.first.erase(stol.first.begin());
        }
        while (!stol.second.empty())
        {
            vec.insert(vec.begin(), stol.second[0]);
            stol.second.erase(stol.second.begin());
        }
    }else{
        while (!stol.second.empty())
        {
            vec.insert(vec.begin(), stol.second[0]);
            stol.second.erase(stol.second.begin());
        }
        while (!stol.first.empty())
        {
            vec.insert(vec.begin(), stol.first[0]);
            stol.first.erase(stol.first.begin());
        }
    }
}

void Porownaj(std::pair<std::vector<int>, std::vector<int>> & stol, std::vector<int> & vec_A, std::vector<int> & vec_B )
{
    if ((!stol.first.empty()) && (!stol.second.empty()))
    {
        if ((*(stol.first.end() -1)) > (*(stol.second.end() -1))) {
            Przeloz(stol, vec_A, 0);
        }
        if ((*(stol.first.end() -1)) < (*(stol.second.end() -1))) {
            Przeloz(stol, vec_B, 1);
        }
        if ((stol.first.size() > 0)&&(stol.first.size() > 0))
            if ((*(stol.first.end() -1)) == (*(stol.second.end() -1)))
            {
                KartaNaStol(stol, vec_A, vec_B);
            }
    }
}

int main() {
    int przegrany{0};
    uint64_t ile_A{0}, ile_B{0};
    std::vector<int> talia;
    std::vector<int> vec_A;
    std::vector<int> vec_B;
    std::pair<std::vector<int>, std::vector<int>> stol;
    for (uint64_t rozdania = 0; rozdania < 1000000000; rozdania++)
    {
        Tasuj(talia);
        Rozdaj(talia, vec_A, vec_B);
        while (!vec_A.empty() && !vec_B.empty())
        {
            KartaNaStol(stol, vec_A, vec_B);
            Porownaj(stol, vec_A, vec_B);
        }
        if (vec_A.empty()) przegrany=0;
        if (vec_B.empty()) przegrany=1;
        if (przegrany) ile_A++; else ile_B++;
        if (rozdania % 60000 == 0)    std::cout << "Gracz A wygral " << ile_A << " razy" << "\t" "Gracz B wygral " << ile_B << " razy\n";
        talia.clear();
        vec_A.clear();
        vec_B.clear();
        stol.first.clear();
        stol.second.clear();
    }
    std::cout << ile_A << "\t" << ile_B << "    Na koniec\n";
    std::cin.get();
    return 0;
}


edytowany 2x, ostatnio: didzni
cerrato
Moderator Kariera
  • Rejestracja:około 7 lat
  • Ostatnio:około 6 godzin
  • Lokalizacja:Poznań
  • Postów:8766
11

Tak na szybko trzy rzeczy mi się rzucają w oczy:

  1. Staraj się używać angielskich nazw - zarówno zmiennych, jak i funkcji
  2. A jakby fragment if ((*(stol.first.end() -1)) > (*(stol.second.end() -1))) (oraz wszystkie podobne) zamienić na if (mozna_przelozyc), a cała logikę sprawdzania dać do osobnej funkcji? W ten sposób masz to ładnie rozbite. Po pierwsze, jakbyś korzystał z tego fragmentu w kilku miejscach, to ewentualne zmiany wprowadzasz tylko raz. A po drugie - analizując kod, nie musisz rozkminiać, co robi fragment stol.first.end() -1)) > (*(stol.second.end() -1 - bo w danej chwili to nikogo nie obchodzi. Jeśli chcesz bawić się w logice tego warunku, to grzebiesz w osobnej funkcji sprawdzającej. A podczas analizowania tego IF nie interesuje Cię sam mechanizm sprawdzenia. Patrzysz i od razu widzisz, że następuje sprawdzenie czy można przełożyć - jeśli tak, to idziemy dalej. Jest to czytelne i wiesz, w jakiej sytuacji ma się ten IF wykonać, nie musisz analizować warunków podanych przy nim.
  3. Odnośnie (int i=12; i<24; i++) - podejrzewam, że to 24 to liczba kart w talii. Ogólnie to stosowanie tzw. magicznych liczb - https://pl.qaz.wiki/wiki/Magic_number_(programming) jest kiepskie. Lepiej by było jakbyś zdefiniował jakąś stałą, która odpowiadać będzie za trzymanie liczby kart w talii, a potem podany powyżej zapis zmienił na (int i=12; i<iloscKartWtalii; i++). Oczywiście - ta ilość kart (zgodnie z uwagą 1 powyżej) powinna być podana po angielsku.

edytowany 5x, ostatnio: cerrato
MarekR22
Moderator C/C++
  • Rejestracja:około 17 lat
  • Ostatnio:4 minuty
3

Najważniejsze: angielski, angielski, angielski, English please. Nieważne jak bardzo będzie łamany i niegramatyczny.
Wszystko co napisał cerrato.

Staraj się dzielić funkcje na możliwie małe elementy. Przykładowo Przeloz: składa się tak naprawdę z jednej funkcji, powtórzonej dwa razy.

Za długie linie (ja preferuję limit 100-120 kolumn lub nawet 80, a 160 to już totalne maksimum). Jeśli podczas czytania kodu musisz przewijać horyzontalnie, jest to bardzo niewygodne.
Większość IDE posiada wtyczkę do formatowania kodu (opartą o clang format) i potrafi sama zawijać wiersze.

Zamknięcie tych funkcji w klasie bardzo uprości kod.

Polecam się zainteresować pisaniem testów za pomocą catch2 lub gtest (IMO to jest część dobrego stylu programowania).


Jeśli chcesz pomocy, NIE pisz na priva, ale zadaj dobre pytanie na forum.
PK
PK
  • Rejestracja:ponad 4 lata
  • Ostatnio:ponad 3 lata
  • Postów:245
2

Pomijając całą resztę to używasz vectorów w bardzo problematyczny sposób, mianowicie mutujesz parametry wejściowe przez co Twój kod, aby móc dobrze zrozumieć trzeba w zasadzie czytać od początku. Oczywiście tego kodu nie ma za wiele, ale tego typu rodzaju podejście utrudni Ci tworzenie większych rzeczy.

Dobre praktyki idą w kierunku bardziej restrykcyjnych technik właśnie po to, aby uniknąć zamieszania jakie wynika z faktu, że w danym momencie w zasadzie wszystko wolno. Droga w kierunku przewidywalnego jest dziwna, bo narzuca coraz więcej ograniczeń, ale ostatecznie taki kod jest prostszy w czytaniu, bo jest dużo bardziej przewidywalny.

didzni
  • Rejestracja:ponad 8 lat
  • Ostatnio:7 miesięcy
  • Postów:133
0

@MarekR22 , jak mam zamknąć te funkcje w klasy? Mam tak napisać program, żeby wszystkie std::vector oraz zmienne były składnikami klasy a funkcje były funkcjami składowymi?

edytowany 1x, ostatnio: didzni
MarekR22
Moderator C/C++
  • Rejestracja:około 17 lat
  • Ostatnio:4 minuty
1
didzni napisał(a):

@MarekR22 , jak mam zamknąć te funkcje w klasy? Mam tak napisać program, żeby wszystkie std::vector oraz zmienne były składnikami klasy a funkcje były funkcjami składowymi?

Krok po kroku.
Np zaczynasz od tego: https://godbolt.org/z/axxYrj
I po kolej przenosisz zmienne lokalne do klasy
Potem, albo w trakcie, dzielisz klasę na mniejsze klasy.
Np dodałbym klasę Reka.
Z czasem większość argumentów metod, możesz usunąć, bo będą korzystać z wartości pól klasy.

Możesz też zacząć od zera.


Jeśli chcesz pomocy, NIE pisz na priva, ale zadaj dobre pytanie na forum.
edytowany 1x, ostatnio: MarekR22
didzni
  • Rejestracja:ponad 8 lat
  • Ostatnio:7 miesięcy
  • Postów:133
0

Zamknąłem funkcje w klasę i dla kart graczy użyłem std::queue bo jest kilkukrotnie szybsza w tym wypadku od std::vector. Wygląda to jako tako?

Kopiuj

#include <iostream>
#include <vector>
#include <chrono>
#include <algorithm>
#include <random>
#include <queue>

std::random_device rd;

class Wojna
{
    int how_many_cards;
    std::vector<int> deck;
    std::queue<int> Player_A;
    std::queue<int> Player_B;
    std::vector<int> table[2];

    void ShuffleDeck(){
        int how_many_figures = how_many_cards / 4;
        for (int i = 0; i < how_many_cards; i++) deck.push_back(i % how_many_figures);
        std::shuffle(deck.begin(), deck.end(), rd);
    }

    void HandOutCards(){
        for (int i = 0; i < (how_many_cards / 2); i++) Player_A.push(deck[i]);
        for (int i = (how_many_cards / 2); i < how_many_cards; i++) Player_B.push(deck[i]);
    }

    void LayCards(){
        if ((!Player_A.empty()) && (!Player_B.empty())) {
            table[0].push_back(Player_A.front());
            Player_A.pop();
            table[1].push_back(Player_B.front());
            Player_B.pop();
        }
    }

    void ShiftCards(std::queue<int> & Player, int winner){
            while (!table[winner].empty())
            {
                Player.push(table[winner][0]);
                table[winner].erase(table[winner].begin());
            }
            while (!table[!winner].empty())
            {
                Player.push(table[!winner][0]);
                table[!winner].erase(table[!winner].begin());
            }
    }

    void Compare(){
        if ((!table[0].empty()) && (!table[1].empty()))
        {
            if ( *(table[0].rbegin()) > *(table[1].rbegin()) )
                ShiftCards(Player_A, 0);

            if ( *(table[0].rbegin()) < *(table[1].rbegin()) )
                ShiftCards(Player_B, 1);

            if ((table[0].size() > 0)&&(table[1].size() > 0))
                if ( *(table[0].rbegin()) == *(table[1].rbegin()) )
                    LayCards();
        }
    }

public:
    Wojna(int howmanycards) : how_many_cards(howmanycards){};
    void Graj() {
        constexpr uint64_t how_many_rounds{10000000};
        uint64_t winner_A{0}, winner_B{0};
        for (uint64_t rounds = 0; rounds < how_many_rounds; rounds++)
        {
            ShuffleDeck();
            HandOutCards();
            while (!Player_A.empty() && !Player_B.empty())
            {
                LayCards();
                Compare();
            }
            if (Player_A.empty()) winner_A++;
            if (Player_B.empty()) winner_B++;
            if (rounds % (600000 / how_many_cards) == 0) std::cout << "Gracz A wygral "
            << winner_A << " razy" << "\t" "Gracz B wygral " << winner_B << "\n";
            deck.clear();
            while (!Player_A.empty()) Player_A.pop();
            while (!Player_B.empty()) Player_B.pop();
            table[0].clear();
            table[1].clear();
        }
    }
};

int main() {
    int ile_kart{0};
    do
    {
        std::cout << "Podaj liczbe kart podzienla przez 4\n";
        std::cin >> ile_kart;
    }while  (ile_kart % 4);
    while (std::cin.get() != '\n') continue;
    Wojna wojna(ile_kart);
    wojna.Graj();
    return 0;
}

edytowany 2x, ostatnio: didzni
Kliknij, aby dodać treść...

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)