User Tools
dydaktyka:cprog:clean_code
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
dydaktyka:cprog:clean_code [2016/07/13 10:11] pkleczek [Umieszczaj każdą instrukcję w osobnej linii kodu.] |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== 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: | ||
| - | <code c> | ||
| - | int a=3;int b=2;int c,d; | ||
| - | </code> | ||
| - | czy | ||
| - | <code c> | ||
| - | int a = 3; | ||
| - | int b = 2; | ||
| - | int c, d; | ||
| - | </code> | ||
| - | |||
| - | ===== 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": | ||
| - | <code c> | ||
| - | int | ||
| - | a | ||
| - | = | ||
| - | 3; | ||
| - | </code> | ||
| - | zamiast | ||
| - | <code c> | ||
| - | int a = 3; | ||
| - | </code> | ||
| - | |||
| - | Kod zbyt ,,ściśnięty'': | ||
| - | <code c> | ||
| - | if (a) { printf("Niewskazane.") } | ||
| - | </code> | ||
| - | zamiast | ||
| - | <code c> | ||
| - | if (a) { | ||
| - | printf("OK."); | ||
| - | } | ||
| - | </code> | ||
| - | |||
| - | ===== "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)
Page Tools
