Czy kod jest czytelny? Dobre praktyki przy pisaniu kodu.

Czy kod jest czytelny? Dobre praktyki przy pisaniu kodu.
ŚC
  • Rejestracja:około 9 lat
  • Ostatnio:ponad 8 lat
  • Postów:36
0

Witam!
Uczę się programowania w Javie ale chciałbym, aby mój kod już od początku był pisany zgodnie z dobrymi praktykami programistycznymi. W związku z tym proszę abyście rzucili okiem czy dobrze kombinuję:
https://github.com/Transell/Guess-Number-game
I jeszcze pytanie: jak tworzyć foldery w GitHub?
Z góry sorki za trywialne pytania.

Pozdr!

spartanPAGE
  • Rejestracja:prawie 12 lat
  • Ostatnio:7 dni
1

Dla Ciebie github powinien wiązać się jedynie z upublicznianiem repozytoriów, nie z ingerencją w nie! Całe repozytorium powinieneś mieć lokalnie.
Czytaj: http://githowto.com/

twonek
  • Rejestracja:ponad 10 lat
  • Ostatnio:prawie 2 lata
  • Postów:2500
0
Kopiuj

for (int i = 0; i < 6;)
{
    if (play == variate)
    {
        ViewText.win();
        break;
    }
    else if (play > variate)
    {
        ViewText.numberIsLower();
        play = scanner.nextInt();
        i++;
    }
    else if (play < variate)
    {
        ViewText.numberIsHigher();
        play = scanner.nextInt();
        i++;
    }
    if (i == 6)
    {
        ViewText.outOfAttempts();
    }
}

ładniej wygląda w tej postaci:

Kopiuj
for (int i = 0; i < 6; ++i)
{
    if (play == variate)
    {
        ViewText.win();
        break;
    }

    if (play > variate)
    {
        ViewText.numberIsLower();
    }
    else
    {
        ViewText.numberIsHigher();
    }

    play = scanner.nextInt();
}
Shalom
  • Rejestracja:około 21 lat
  • Ostatnio:prawie 3 lata
  • Lokalizacja:Space: the final frontier
  • Postów:26433
3

Not even close ;)

  1. Magic numbers w kodzie. Zamiast random.nextInt(101); lepiej zrobic stałą o dobrej nazwie i wołać random.nextInt(MAX_ATTEMPTS); albo coś takiego
  2. for (int i = 0; i < 6;) jw -> i<maxTurnsNumber ;)
  3. Ten warunek na i=6 jest bez sensu i niepotrzebny, wystarczy że po wygranej zrobisz return.
  4. Cała ta funkcja z iflogią jest słaba. A jakby opcji było np. 100 to też byś tak rozpisywał? Po enterprajsowemu to należałoby zamiast warunków w ifach zrobić sobie jakieś klasy/lambdy w stylu Predicate które testują daną zależność, a potem odpalać je sobie wszystkie w jednej pętli po kolei i wypisywać komunikat zależnie od tego który predykat jest spełniony. Dzięki temu można sobie dodawać kolejne warunki bez konieczności powiększania drabinki ifów.

"Nie brookliński most, ale przemienić w jasny, nowy dzień najsmutniejszą noc - to jest dopiero coś!"
ŚC
  • Rejestracja:około 9 lat
  • Ostatnio:ponad 8 lat
  • Postów:36
0

Dzięki za komentarze. Mi generalnie chodziło o tworzenie klas itp czy w dobrą stronę idę jeśli o to chodzi. Czytelność kodu w ujęciu ogólnym. Tzn metody obliczeniowe wkładam tutaj, te odpowiedzialne za wyświetlanie tekstu tam itd. Logika układania kodu.

edytowany 1x, ostatnio: Świetlisty Cheddar
ŚC
  • Rejestracja:około 9 lat
  • Ostatnio:ponad 8 lat
  • Postów:36
0

Aha i jeszcze pls o to jak tworzy się foldery w GitHube :)

pingwindyktator
  • Rejestracja:ponad 12 lat
  • Ostatnio:25 dni
  • Lokalizacja:Kraków
  • Postów:1055
0

Normalnie tworzysz folder i commitujesz.


do not code, write prose
ŚC
  • Rejestracja:około 9 lat
  • Ostatnio:ponad 8 lat
  • Postów:36
0

Tak, z tym że jak klikam new file to tworzy mi plik tekstowy.

0

Co to znaczy commitować?

wojciechmaciejewski
  • Rejestracja:ponad 12 lat
  • Ostatnio:około 2 lata
  • Postów:560
MS
  • Rejestracja:prawie 10 lat
  • Ostatnio:około 2 miesiące
  • Postów:100
0

Sprawdź sobie co to:
git init
git status
git add
git commit
git push
git pull
Na początek powinno wystarczyć

Azarien
  • Rejestracja:ponad 21 lat
  • Ostatnio:około godziny
0
pingwindyktator napisał(a):

Normalnie tworzysz folder i commitujesz.

Git nie potrafi przechowywać pustych katalogów. Musi tam być choć jeden zakomitowany plik.
Jako konwencja przyjęło się tworzenie pliku o nazwie .gitkeep jeśli katalog ma być „pusty”.

pingwindyktator
To prawda oczywiście.
ŚC
  • Rejestracja:około 9 lat
  • Ostatnio:ponad 8 lat
  • Postów:36
0
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)