Jak pisać lepiej kod

Jak pisać lepiej kod
0

Witam
Mam pewien dylemat, od paru lat piszę w javie czy to na studiach czy teraz w pracy ale czuje że średnio ją umiem. Piszę różny kod ładny i brzydki ale często mnie język zaskakuje. Macie jakieś porady jak stać się lepszym. Jak lepiej poznać język nauczyć, wpoić sobie pewne dobre zasady i pracować z nim płynnie bez sytuacji że na wątkach traci się tydzien a chodzi to i tak że ...

spartanPAGE
warning: kodzenie może powodować błędy
Madaoo
  • Rejestracja:ponad 12 lat
  • Ostatnio:ponad rok
  • Postów:490
1

Moja pomoc to: praktyka, praktyia i praktyka.

Do tego jeszcze jakaś książka, na temat wzroców i stosowania ich w kodzie.


"Chodzenie po wodzie i tworzenie oprogramowania wg specyfikacji są łatwe, o ile woda i specyfikacja są zamrożone" - Edward V. Berard
Shalom
  • Rejestracja:około 21 lat
  • Ostatnio:prawie 3 lata
  • Lokalizacja:Space: the final frontier
  • Postów:26433
3

@Mateusz321 najlepiej pisać kod ale jedncześnie mieć też code-review. Tzn ktoś na ten twój kod patrzy i rzuca WTFami.


"Nie brookliński most, ale przemienić w jasny, nowy dzień najsmutniejszą noc - to jest dopiero coś!"
Koziołek
Moderator
  • Rejestracja:prawie 18 lat
  • Ostatnio:dzień
  • Lokalizacja:Stacktrace
  • Postów:6821
3

Trochę będę korzystał z linków do własnego bloga, ale mam tam to uporządkowane.

Na początek zacznij stosować zasady DRY i KISS na co dzień. Obie są na tyle proste, i mają wsparcie w narzędziach, że nie powinieneś mieć problemu.
Kolejna rzecz to zasada SOLID > http://koziolekweb.pl/category/inzynieria-oprogramowania/solidne-programowanie/ poprawia kod.
Następnie pamiętaj o pisaniu testów. Wiem, że to uciążliwe gdy deadline goni, ale testy zazwyczaj pozwalają nie tylko na wyszukanie potencjalnych bugów, ale też dzięki nim możesz sprawdzić jak twój kod będzie "się używał". Jeżeli coś jest ciężko przetestować to oznacza, że i użycie będzie przysparzać problemów.
Kolejna sprawa to http://koziolekweb.pl/tag/ekstremalna-obiektowosc-w-praktyce/ poczytaj. To stare teksty, ale nadal aktualne. Nie trzeba się ściśle trzymać tych zasad lecz ich stosowanie znacząco ułatwia pisanie dobrego kodu.
@Madaoo wspominał o książkach. Ja powiem tylko o jednej http://koziolekweb.pl/2008/11/07/zrozumiec_tao/ . Książka, jak książka. Pozwala jednak zrozumieć jak działają wzorce obiektowe i kiedy nie należy ich stosować. To, wbrew pozorom, bardzo ważna rzecz, dzięki której można pisać lepszy kod.

Najważniejsze - praktyka. Najlepiej praktykuje się na projektach OSS. Zatem postaraj się tworzyć kod w oparciu o ww. zasady i udostępniać go szerszej publiczności.


Sięgam tam, gdzie wzrok nie sięga… a tam NullPointerException
MarekR22
przeczytałem na próbę jeden artykuł i zapewne przeczytam kolejne :).
lipkerson
  • Rejestracja:ponad 17 lat
  • Ostatnio:ponad 2 lata
1

Ja myślę, że samo pisanie testów nie jest tak ważne, jak to by przestać pisać kod, którego nie można przetestować. Jest wiele pozycji w necie na ten temat. I nie dziwi fakt że kod taki który jest lepiej napisany pod względem możliwości pisania testów jednostkowych jest czytelniejszy i po prostu lepszy.


Another jam from the world for the jam from the voices of the world......
Koziołek
Moderator
  • Rejestracja:prawie 18 lat
  • Ostatnio:dzień
  • Lokalizacja:Stacktrace
  • Postów:6821
1

@lipkerson, tyle tylko, że pisanie kodu, który łatwo się testuje jest najprostsze gdy piszesz testy. Widać wtedy jak na dłoni czy rozwiązanie jest OK czy NOK. Tu wchodzi kolejna sprawa test-first czy test-last? IMO test-first pomaga pisać dobry kod, a przy wsparciu narzędzi do refaktoryzacji pozwala na eleganckie rozwijanie kodu z poziomu bardzo prostego i pokrywającego tylko najprostsze wymaganie do bardziej złożonego i zgodnego z pełną specyfikacją.


Sięgam tam, gdzie wzrok nie sięga… a tam NullPointerException
lipkerson
no tak po inżyniersku to chyba na końcu należy testować. Trzeba mieć dobry team ludzi którzy już wiedzą co i jak to wtedy pisanie testu na początku jest rozsądne. Tak jak połowa sie uczy, połowa jest przerzucona z innych technologi to tylko dysonanse wyjdą i niepotrzebnie stracony czas. Ale to tylko moje zdanie z podwórka na którym ja się bawię:)
Koziołek
No tak po inżyniersku, ale inżynieria oprogramowania ma niewiele wspólnego z inżynierią. TS pozwala na "dogadanie" API takiego jakie jest rzeczywiście potrzebne.
0

Bardzo Wam dziękuję za wszystkie informacje. Dziś pewnie poczytam trochę bloga. A co możecie powiedzieć na sytuacje gdy ktoś chce się uczyć dobrze programować i pogłębiać samą wiedzę na temat języka głownie chodzi o Jave.

Koziołek
Moderator
  • Rejestracja:prawie 18 lat
  • Ostatnio:dzień
  • Lokalizacja:Stacktrace
  • Postów:6821
1

Pisz OSSy. Cokolwiek co ma ręce i nogi będzie dobre. Poszukaj sobie tematu i napisz apkę, która będzie miała kod na np. githubie. Daj ją na forum do oceny i DYSKUTUJ o zastosowanych rozwiązaniach.


Sięgam tam, gdzie wzrok nie sięga… a tam NullPointerException
Gjorni
  • Rejestracja:około 12 lat
  • Ostatnio:około 3 lata
1

Nie wiem, czy tak jest w istocie, ale myślę, że w programowaniu bardzo cenny jest wręcz paranoiczny perfekcjonizm idący w parze z wyczulonym zmysłem estetycznym. Bowiem prócz wielkiego brata spoglądającego na monitor przez nasze ramię i rzucającego ładefakami w sytuacji dostrzeżenia wypisanych przez nas różnorakich bzdur, to jednak nic nie zastąpi wewnętrznego irytującego głosiku szepczącego, że "twój kod nie wygląda tak, jak wyglądać powinien kolego... nie wiem co zrobiłeś nie tak, ale radziłbym ci poszukać w necie informacji dotyczących stosowania tego rozwiązania/funkcji/itd bo pachnie mi tu fuszerką". Na pewnych etapach rozwoju wiadomo, że należy kontrolować ów perfekcjonistyczny zapęd i za każdym razem iść na kompromis z samym sobą w celu akceptacji rozwiązań "dających radę i mieszczących się w pewnych grupowych standardach", jednak wyrobienie w sobie poczucia dobrego smaku i wyżej wspomnianego zmysłu estetycznego moim zdaniem jest bardzo istotną kwestią. Tak jak z grą na pianinie, tak i przy pisaniu książki, tak i przy kodzeniu po prostu "czuje się", że zastosowane rozwiązanie, czy forma w jakiej ujęliśmy jakąś funkcję jest brzydka, nieodpowiednia, nieelegancka, za długa, przestarzałą, niepoprawna itd itd.


The quieter you become, the more you are able to hear.
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)