Czysty kod, przejrzystość czy zwięzłość.

Czysty kod, przejrzystość czy zwięzłość.
mic1996
  • Rejestracja:około 8 lat
  • Ostatnio:około 2 lata
  • Postów:52
0

Witam.
Ogólnie pytanie należy raczej do banalnych, ale co jest ważniejsze, przejrzystość, czy zwięzłość? Mam na myśli na przykład oddzielanie kolejnych metod pustą linią, zamiast pisania jednej pod drugą. Ogólnie większość projektów jest napisanych bez oddzielania, jednak gdybym pisał w ten sposób, to czy jest to w jakimś stopniu niepoprawne? Czytałem ,że to kwestia indywidualna ale jednak wiadomo, że jakieś standardy są. Tak samo z klamrami w jednej kolumnie, pisząc w ten sposób kod według mnie wydaje się bardziej przejrzysty, jednak raczej nie spotkałem się z takim formatowaniem.

Kopiuj
mojaMetoda
{

pierwszaMetoda();

drugaMetoda();

}
Kopiuj
mojaMetoda(){
pierwszaMetoda();
drugaMetoda();
}
atmal
  • Rejestracja:prawie 8 lat
  • Ostatnio:2 dni
  • Postów:913
1

Takie oddzielanie pustą linią jest według mnie nieczytelne bo czasami nie będzie widać związku między dwoma metodami/zmiennymi. Lepiej grupować kod, dla przykładu (źródło - Jądro Linux'a)

Kopiuj
static void push_rest(const char *name)
{
	unsigned int name_len = strlen(name) + 1;
	unsigned int tmp_ofs;

	fputs(name, stdout);
	putchar(0);
	offset += name_len;

	tmp_ofs = name_len + 110;
	while (tmp_ofs & 3) {
		putchar(0);
		offset++;
		tmp_ofs++;
	}
}

Co do klamer - ja preferuje gdy są na osobnej linii, czyli tak jak w pierwszym przykładzie który podałeś, ale dużo ludzi woli drugą opcję.
Najważniejsze jest to aby trzymać się danego stylu - czy to narzuconego przez istniejący już projekt czy też gdy piszesz coś samemu.

Zainteresuj się książką "Czysty Kod" napisaną przez Roberta C. Martina ;)


Failure of one test is a tragedy, failure of fifty is a statistic.
mic1996
  • Rejestracja:około 8 lat
  • Ostatnio:około 2 lata
  • Postów:52
0

Jestem właśnie w trakcie czytania :) Ogólnie mam dylemat, czy po prostu przestawić się właśnie na takie pisanie linia pod linią bo jest to bardziej powszechne, czy styl gdzie robię przerwy pomiędzy metodami, które są powiedzmy kolejnymi etapami algorytmu też będzie dobry?

atmal
  • Rejestracja:prawie 8 lat
  • Ostatnio:2 dni
  • Postów:913
0

Tak jak napisałem, pisze się tak że jest linia pod linią i jedynie oddzielasz grupy. Ciężko to opisać na tak abstrakcyjnych przykładach, będziesz musiał to "wyczuć" kiedy warto coś rozdzielić :D


Failure of one test is a tragedy, failure of fifty is a statistic.
axelbest
  • Rejestracja:ponad 17 lat
  • Ostatnio:3 minuty
  • Lokalizacja:Warszawa
  • Postów:2251
0

Rób tak żeby było czytelnie :) z tymi enterami też nie przesadzaj - bo potem będziesz miał taki ser szwajcarski. @atmal pokazał Ci dobry fragment kodu. Ładny, czytelny, aczkolwiek nazwy zmiennych nic mi nie mówią, osobiście taką funkcję bym napisał z camelCase'm - no ale tak się pewnie pisze jądra w c :)

mechanix
  • Rejestracja:około 9 lat
  • Ostatnio:9 dni
  • Postów:501
0
mic1996 napisał(a):

ale co jest ważniejsze, przejrzystość, czy zwięzłość?

Zawsze przejrzystość (cokolwiek przez to rozumiesz). Lepiej raz przeczytać 100 znaków niż 4 razy 50.

Mam na myśli na przykład oddzielanie kolejnych metod pustą linią, zamiast pisania jednej pod drugą.

Tylko po co. Jak już to lepiej grupować pewne elementy w metodzie. Ale pewnie znajdą się tacy, że żadnych przerw bo metoda powinna robić jedną rzecz więc nie trzeba żadnych odstępów.

mic1996
  • Rejestracja:około 8 lat
  • Ostatnio:około 2 lata
  • Postów:52
0

Rozumiem, po prostu kod wydawał mi się czytelniejszy, gdy robię odstępy, trochę jak pisanie w zeszycie w kratkę :D niby można pisać linia po linii, jednak każdy robi odstęp.

JU
  • Rejestracja:około 22 lata
  • Ostatnio:28 dni
  • Postów:5042
0

Takie odstępy są bezsensowne i sprawiają, że kod jest mimo wszystko mniej czytelny. Tak, jak mówi @atmal Ja też robię w taki sposób, że "grupuję" powiązane ze sobą fragmenty. I wtedy kod jest chyba najbardziej czytelny, bo od razu wiadomo, że coś jest ze sobą w jakiś sposób powiązane.

Progress
  • Rejestracja:ponad 10 lat
  • Ostatnio:ponad 3 lata
  • Postów:220
0

Odstępy, dokładnie tak jak pisali poprzednicy, dawaj miedzy grupami kodu, a nie każdą linijką. Jak wyjdzie Ci jakaś większa grupa to może być znak, że warto się zastanowić, czy ta grupa nie powinna zostać wydzielona do osobnej metody.

Jeżeli chodzi o klamry to raczej zależy od języka. W C# zawsze robi się klamry w osobnych liniach i nigdy nie widziałem, żeby ktoś robił inaczej. W językach skryptowych np. JS klamry są w jednej linii z nazwa metody i Javie chyba też się tak robi, ale na szczęście dawno nie widziałem kodu w Javie więc nie jestem pewien.

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)