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

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.

mojaMetoda
{

pierwszaMetoda();

drugaMetoda();

}
mojaMetoda(){
pierwszaMetoda();
drugaMetoda();
}
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)

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 ;)

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?

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

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 :)

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.

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.

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.

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.

1 użytkowników online, w tym zalogowanych: 0, gości: 1