Prośba o ocenę kodu aplikacji

Prośba o ocenę kodu aplikacji
ZD
  • Rejestracja:ponad 9 lat
  • Ostatnio:ponad 7 lat
  • Postów:99
0

Witam. Co prawda jakiś czas temu prosiłem tutaj o ocenę tego samego programu, jednak było to bardzo dawno i napisałem go właściwie całkowicie od nowa. Trochę się od tamtej pory nauczyłem, więc wydaje mi się, że kod nie jest już tak tragiczny jak wtedy. Niemniej jednak na pewno nie jest idealny, dlatego proszę osoby bardziej doświadczone ode mnie o jego ocenę ;)
Jako, że prowadzę bloga i opisywałem na nim już ten projekt, żeby się nie powtarzać zostawię tylko linka: http://csharp-dev.pl/2016/11/18/cleaner-net-krotka-prezentacja/

GitHub: https://github.com/lukaszpl/Cleaner.NET

Pozdrawiam!

Riddle
Administrator
  • Rejestracja:prawie 15 lat
  • Ostatnio:minuta
  • Lokalizacja:Laska, z Polski
  • Postów:10056
2

Unikaj takich długich metod jak SettingsLoader.SaveSettings().

Mam na myśli to że powinieneś ją skrócić.

edytowany 1x, ostatnio: Riddle
ZD
  • Rejestracja:ponad 9 lat
  • Ostatnio:ponad 7 lat
  • Postów:99
0

Dzięki za odpowiedź ;)

Fakt, można skrócić metody w tej klasie. Poprawię to.
Co do reszty, obyło się bez jakiś większych błędów?

Sarrus
  • Rejestracja:prawie 14 lat
  • Ostatnio:około 5 godzin
  • Postów:2512
2

Te nazwy nie są za długie. Zauważ tylko, że w SettingsLoader.SaveSettings() dwa razy pojawia się słowo Settings. Poza tym w Loader masz Save co do siebie średnio pasuje. Moim zdaniem mógłbyś klasę nazwać po prostu Settings i nazwać metody Load i Save

ZD
W sumie masz rację. Ja to pisałem, więc od razu wiem o co chodzi. Ktoś kto patrzy na kod z boku może źle się zasugerować nazwą... Kurcze, zawsze mam problem z dobrym nazywaniem klas/metod :P PS: Do czegoś jeszcze można się przyczepić prócz nazewnictwa? :) PS2: Koledze wyżej chodziło chyba o wnętrze metody, nie jej nazwę. Przynajmniej ja to tak zrozumiałem.
Sarrus
Tak masz rację - nie chodziło o nazwę.
Riddle
Administrator
  • Rejestracja:prawie 15 lat
  • Ostatnio:minuta
  • Lokalizacja:Laska, z Polski
  • Postów:10056
3

Ten kod się powtarza. Nie dość że w if oraz else jest to samo, to jeszcze w trzech miejscach:

Kopiuj
if (DoClean)
                return Languages.Lang.Recentdoc_CheckBox + ": " + Size + " MB" + "\n\n";
            else
                return Languages.Lang.Recentdoc_CheckBox + ": " + Size + " MB" + "\n\n";

Jak masz taki sam kod to nie kopiuj-wklej go w dwóch miejscach tylko wydziel do metody, i ją wywołaj.

Poza tym to:

Kopiuj
if (a) {
    return b;
} else {
    return c;
}

zawsze piszę tak

Kopiuj
if (a) {
    return b;
}
return c;
ZD
Nie mogę przestać się śmiać... Po co ja tam dałem tego if'a hahaha. Akurat ta klasa została mi z poprzedniego projektu i trochę bezmyślnie ją poprzerabiałem... Dzięki za zwrócenie uwagi! Pewnie zauważyłbym to dopiero po jakimś dłuższym czasie. Do poprawy ;)
Riddle
@Zdziwiony Nie tylko ten if. Drugi taki sam kod jest w metodzie niżej (w sumie tego jest 4) więc wydziel to.
ZD
Pousuwałem te ify we wszystkich metodach i puściłem od razu poprawkę na serwer.
Riddle
Administrator
  • Rejestracja:prawie 15 lat
  • Ostatnio:minuta
  • Lokalizacja:Laska, z Polski
  • Postów:10056
1

Linijka 44 w klasie XmlReader.cs.

Kopiuj
XmlNodeList Shops = XmlDoc.SelectNodes("//userSettings//Cleaner.NET.Properties.AppSettings//setting[@name = '" + Name + "']//value");

To jakby "dwie rzeczy". Dwie odpowiedzialności, powinieneś z tego zrobić coś takiego:

Kopiuj
XmlNodeList Shops = XmlDoc.SelectNodes(GetSettingsFilename(Name));

Tzn zrobić funkcję GetSettingsFilename() żeby ona zwracała ten string.

ZD
Hmm, fakt będzie bardziej uniwersalnie. Wpisany na sztywno tekst będzie powodem problemów, w przypadku zmiany nazwy projektu. Cenna uwaga :) PS: Jeżeli masz czas i chęci to będę mega wdzięczny za przejrzenie reszty kodu i wytknięcie tu kolejnych błędów/zasugerowania rozwiązań. Będę w przyszłym tygodniu wszystko poprawiał. Serdecznie dzięki za pomoc!
Sarrus
Poza tym zauważ, że możesz wówczas napisać test sprawdzający czy nazwa pliku jest pobierana poprawnie. Bez tej zmiany jest to niemożliwe.
Riddle
Administrator
  • Rejestracja:prawie 15 lat
  • Ostatnio:minuta
  • Lokalizacja:Laska, z Polski
  • Postów:10056
0

To co jeszcze to CleanClass.cs linijki 32-40, to co jest w środku ifa, całe, powinno być wydzielone do innej funkcji. Linijka 43, to co jest w returnie też do innej funkcji.

Te dziwne komentarze chrome/firefox/opera w klasie CleanClass wyglądają jakby jakby można z nich było zrobić interfejs i 3 klasy polimorficzne (ale może to zrób na końcu). Na razie możesz po prostu z nich zrobić 3 klasy CleanChrome, CleanOpera i CleanFirefox i tyle.

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)