Najważniesze zasady Clean Code

Najważniesze zasady Clean Code
SU
  • Rejestracja:ponad 10 lat
  • Ostatnio:4 miesiące
  • Postów:247
0

Witam. Chciałbym się Państwa zapytać, jakie zasady czystego kodu uważacie za najważniejsze, takie które każdy szanujący się programista powinien posiadać?

DE
  • Rejestracja:ponad 9 lat
  • Ostatnio:11 miesięcy
  • Postów:1788
1
mr_jaro
  • Rejestracja:prawie 14 lat
  • Ostatnio:ponad 3 lata
  • Lokalizacja:Grudziądz/Bydgoszcz
  • Postów:5300
0

SOLID


It's All About the Game.
Riddle
Administrator
  • Rejestracja:prawie 15 lat
  • Ostatnio:około 4 godziny
  • Lokalizacja:Laska, z Polski
  • Postów:10066
1

Cały Clean Code jest chyba istotny.

dzek69
Moderator
  • Rejestracja:ponad 18 lat
  • Ostatnio:18 dni
  • Lokalizacja:Rzeszów
2

Zdecydowanie KISS. Dlaczego? Bo mało kto umie się do tego zastosować, jednocześnie twierdząc, że stosuje.
Nawet "duzi" gracze lubią nadskomplikowany kod czy nawet nie tyle kod, co rozwiązania. Przykłady:

  1. Angular i jego "dependency injection", polegającą na tym, że jak nazwiesz sobie zmienną, to odpowiednią wartość ona przyjmie.
  2. Podobnie dzieje się w Symfony, tam dodatkowo routing definiujesz w komentarzu do metody.

A typowy programista klepacz też produkuje nadskomplikowany kod, ale w mniejszej skali. Naśmieszniejsze jest to, żę jakby x lat temu, przed modą na routing w komentarzach jakiś szaraczek zaproponowałby takie rozwiązanie, to by go zjedli. Potem wpada wielki framework, proponuje takie gównorozwiązanie, a wszyscy się cieszą i traktują to jako nową religię i kopiują rozwiązania do siebie.

Osobiście nie wiem kto pierwszy to wymyślił, pierwszy raz widziałem to w Symfony, więc im się dostało.


Zobacz pozostałe 5 komentarzy
axelbest
Ale żeś dał mocny przykład :)
axelbest
@vpiotr dokladnie o adnotacje mi chodzilo.
vpiotr
@axelbest: Adnotacje w Java (czy dekoratory w Python) to element języka i normalnie działa w kodzie bez samodzielnej implementacji parsowania. Kompilator języka może nawet do tego zgłaszać błędy. Automatycznie się formatują. Komentarze to co innego - też jestem zdania że kod w komentarzach burzy naturalne feng szui programisty, niemniej jeśli dzięki temu coś można zrobić prościej to ostatecznie może być i komentarz.
pkozak_pl
Z tym zastosowaniem się do KISS to różnie jest, ponieważ coś prostego można inaczej postrzegać. Dla jednej osoby to forma obchodzenia problemów bez wytaczania ciężkich rozwiązań (typowe dla bibliotek/microframeworków), a dla drugiej to coś co ostatecznie pozwoli mu rozwiązać problem jeszcze szybciej (typowe dla frameworków).
Maciej Cąderek
Maciej Cąderek
@pkozak_pl Należy rozróżnić proste a łatwe - łatwe jest subiektywne, proste nie - tutaj masz piękny wykład na ten temat: https://www.youtube.com/watch?v=rI8tNMsozo0 Chyba o to chodzi @dzek69 i tu się z nim w 100% zgadzam
pkozak_pl
  • Rejestracja:ponad 8 lat
  • Ostatnio:około 8 lat
  • Lokalizacja:Kraków
  • Postów:19
0

Każdy szanujący się programista nie powinien przesłaniać rozwagi złotymi regułami. Ponadto zasady dobrego kodu mogą być sprzeczne np. DRY ciągnie w kierunku uogólnienia (złożony kod), a KISS w kierunku prostych rozwiązań. Co by nie wybrać i tak ktoś będzie marudził :-)

kchteam
  • Rejestracja:ponad 10 lat
  • Ostatnio:ponad 7 lat
  • Lokalizacja:Tychy
  • Postów:155
0

Wydaje mi się, że kompozycja SOLID, KISS i DRY to zasady, których rozsądne stosowanie da wymierne efekty w postaci lepszego kodu.
Rozsądne, czyli nie bezkrytyczne - trzeba wiedzieć kiedy przestać i kiedy kod jest "wystarczająco dobry" - próbowanie dopasowania się do wszystkich "złotych reguł" prawdopodobnie zaprowadzi Cię do nadmiernie rozdrobnionego kodu.

Zatem najważniejsze to, tak jak napisał @pkozak_pl, nie tracić rozwagi i swój kod pisać tak, żeby był dobry, czyli, żeby działał i był czytelny dla innych programistów.

[Adam]


Jeden zespół, tysiące możliwości!
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)