Prośba o sprawdzenie jakości kodu

Prośba o sprawdzenie jakości kodu
T8
  • Rejestracja:ponad 7 lat
  • Ostatnio:ponad 6 lat
0

Witam.

Bardzo bym prosił o sprawdzenie poniższego kodu. Kod działa tak jak chcę, ale ponieważ uczę się sam, to chciałym, żeby ktoś zweryfikował jakość mojego kodu.

Założenie są takie. Mam dwie klasy. Klasa Object ma dwa pola(string i int), a klasa ClassWithVector ma pole typu string i vector wskaźników do obiektów klasy Object. W tym momencie te klasy oczywiście nie mają większego sensu, ale chcę ten kod wykorzystać przy robieniu projektu, a to co wstawiam poniżej służy tylko do ćwiczeń. Chciałbym z poziomu programu dodawać do vectora nowe elementy. Zawartość vectora ma być wczytana z pliku podczas tworzenia obiektu, a następnie, tak zmodyfikowany vector ma być zapisany do pliku.

Z góry bardzo dziękuję za wszelkie krytyczne uwagi.

Kopiuj
#ifndef OBJECT_H_INCLUDED
#define OBJECT_H_INCLUDED

class Object
{
    private:
    std::string name;
    int age;

    public:
    Object ( std::string name, int age );
    std::string getName();
    int getAge();
};

#endif // OBJECT_H_INCLUDED

Kopiuj
#include <vector>
#include <string>
#include "Object.h"
using namespace std;


Object::Object( string name, int age )
{
    this->name = name;
    this->age = age;
};


string Object::getName()
{
    return this->name;
}

int Object::getAge()
{

    return this->age;
}

Kopiuj
#ifndef CLASSWITHVECTOR_H_INCLUDED
#define CLASSWITHVECTOR_H_INCLUDED

class Object;

class ClassWithVector
{
    private:
    std::string name;
    std::vector<Object*> objects;
    public:
    ClassWithVector ( std::string name );
    void readDataFromFile();
    void saveDataToFile();
    void vecToString();
    std::vector<Object*>* getVector();
    void addObjectsToVector( Object* o, std::vector<Object*>* vec );

};

#endif // CLASSWITHVECTOR_H_INCLUDED

Kopiuj
#include <boost/algorithm/string.hpp>
#include <fstream>
#include <iostream>
#include <vector>
#include <string>
#include "ClassWithVector.h"
#include "Object.h"
using namespace std;

ClassWithVector::ClassWithVector( string name )
{
    this->name = name;
    vector <Object*> objects;
    readDataFromFile();
};

void ClassWithVector::readDataFromFile()
{
    string oneLine;
    int intLine;
    fstream myFile;
    string fileName = "file";


    myFile.open( fileName, ios::in );
    if( myFile.good() == true )
    {
        cout << "The file is being read...\n";
        while( getline( myFile, oneLine ) )
        {
            vector<string> strs;
            boost::split(strs, oneLine, boost::is_any_of(" "));
            intLine = stoi(strs[1]);
            //cout<<strs[0]<<" "<<strs[1]<<"\n";
            Object *obj = new Object(strs[0], intLine);
           // cout<<obj->getName()<<"  "<<obj->getAge()<<"\n";
            this->objects.push_back(obj);
        }
        cout<<"End of the file.\n\n\n";
        myFile.close();

    }
    else
        cout << "There's a problem with reading the file :(\n\n\n";
}


void ClassWithVector::saveDataToFile()
{

    string oneLine;
    fstream myFile;
    string fileName = "file";


    myFile.open( fileName, ios::out  );
    if( myFile.good() == true )
    {
        cout << "The file is being opened...\n";
        for ( Object *o : objects )
        {
            myFile<<o->getName()<<" "<<o->getAge()<<"\n";

        }
        cout<<"End of writinig the data to the file.\n\n\n";
        myFile.close();

    }
    else
        cout << "There's a problem with opening the file :(\n\n\n";
}

void ClassWithVector::addObjectsToVector( Object* o, vector<Object*> *vec )
{
    vec->push_back(o);
}

void ClassWithVector::vecToString()
{
    for( Object *o : objects )
    {
        cout << o->getName();
        cout<<"  "<<o->getAge()<< "\n";
    }
}

vector<Object*>* ClassWithVector::getVector()
{
    cout<<"size in get: "<<this->objects.size()<<"\n";
    return &(this->objects);
}

int main()
{

    ClassWithVector c( "a1" );
    Object *o1 = new Object("n1", 1);
    Object *o2 = new Object("n2", 2);
    Object *o3 = new Object("n3", 3);
    c.addObjectsToVector(o1, c.getVector());
    c.addObjectsToVector(o2, c.getVector());
    c.addObjectsToVector(o3, c.getVector());


    c.saveDataToFile();
    c.vecToString();

return 0;
}

edytowany 2x, ostatnio: flowCRANE
cerrato
Może się czepiam i szukam dziury w całym, ale strasznie mnie drażnią komentarze w kodzie, który ktoś wrzuca.
RE
  • Rejestracja:ponad 18 lat
  • Ostatnio:31 minut
0

wrzucić na https://review.gerrithub.io/
a później można o jakimś review gadać.


We are the 4p. Existence, as you know it, is over. We will add your biological and technological distinctiveness to our own. Resistance is futile
tajny_agent
  • Rejestracja:ponad 11 lat
  • Ostatnio:ponad rok
  • Postów:1340
2
  1. W konstruktorze Object użyj listy inicjalizacyjnej. Identycznie w przypadku ClassWithVector.
  2. Funkcje Object::getName i Object::getAge nie modifykują obiektu, więc oznacz je jako const
  3. W ciele konstruktora ClassWithVector linijka vector<Object*> objects jest zupełnie nie potrzebna.
  4. Boost jest zbędny. Wczytywanie można znacznie uprościć
  5. Serializację klasy Object przeniósłbym do klasy Object.
  6. Funkcja ClassWithVector::addObjectsToVector jest bezsensu.
  7. Funkcja ClassWithVector::getVector niech zwraca stałą referencję do vector<Object*> (jeśli w ogóle upublicznianie prywatnej składowej jest konieczne)
  8. Ciężko powiedzieć do czego służy klasa Object. Dlaczego nie użyjesz wektora obiektów zamiast wektora wskaźników? A jeśli już muszą być wskaźniki to pomyśl nad std::shared_ptr/std::unique_ptr.

"I love C++. It's the best language in the world right now for me to write the code that i need and want to write"
~ Herb Sutter
MarekR22
Moderator C/C++
  • Rejestracja:około 17 lat
  • Ostatnio:3 minuty
2
  1. nazwa Object jest zbyt generyczna, nic nie mówi o funkcjonalności klasy. Może lepsze by było: Person, VentageItem
  2. standardy kodowania C++, mówią że pola powinny być na końcu.
  3. nazwa ClassWithVector jest zła, bo mówi o szczegółach implementacji, a nie o funkcjonalności
  4. surowe wskaźniki to obecnie anachronizm (>=C++11) w tym kontekście
  • brak konstruktora kopiującego lub jego blokady (brak surowych wskaźników spowodowałby, że sprawa rozwiązuje się sama)
  • w zasadzie dla tego kodu wskaźniki to overkill
  1. porównanie wartości bool do true dla większości jest dziwne.
  2. każdy blok w if else lepiej otoczyć klamrami, nawet jeśli jest to jedna linijka (dobra praktyka).
  3. trzeba było użyć std::istringstream a nie boost::split.
  4. po kiego grzyba dodatkowy argument w void addObjectsToVector( Object* o, std::vector<Object*>* vec );?

Jeśli chcesz pomocy, NIE pisz na priva, ale zadaj dobre pytanie na forum.
edytowany 3x, ostatnio: MarekR22
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)