User Tools

Site Tools


dydaktyka:cprog:clean_code

This is an old revision of the document!


Jak uczynić Twój program czytelnym?

Nadawaj rozsądne identyfikatory

Stosuj identyfikatory, które oddające rolę danej zmiennej, cel działania funkcji itp.

Dokumentuj kod

Używaj komentarzy tam, gdzie to wskazane.

Używaj odstępów i pustych linii

Język C to język swobodnej postaci, czyli kompilator po prostu pomija takie znaki niedrukowane.

Odpowiedz sobie na pytanie, co bardziej czytelne:

int a=3;int b=2;int c,d;

czy

int a = 3;
int b = 2;
int c, d;

Umieszczaj każdą instrukcję w osobnej linii kodu

Język C dopuszcza zarówno umieszczanie wielu instrukcji w jednej linii, jak też rozbicie jednej instrukcji na wiele linii (co jednak zmniejsza czytelność).

Kod zbyt “rozwleczony”:

int
a
=
3;

zamiast

int a = 3;

Kod zbyt ,,ściśnięty'':

if (a) { printf("Niewskazane.") }

zamiast

if (a) {
    printf("OK.");
}

"Złota zasada"

Pamiętaj – obecnie, w dobie szybkich komputerów i dużej ilości dostępnej pamięci operacyjnej, głównym celem programisty staje się napisanie działającego, czytelnego kodu. Optymalizacje i “sztuczki” zazwyczaj nie popłacają…

dydaktyka/cprog/clean_code.1468397493.txt.gz · Last modified: 2020/03/25 11:46 (external edit)