Czysty kod Podrecznik dobrego programisty.pdf

Czysty kod. Podrêcznik

dobrego programisty

Autor: Robert C. Martin

T³umaczenie: Pawe³ Gonera

ISBN: 978-83-246-2188-0

Tytu³ orygina³u : Clean Code: A Handbook

of Agile Software Craftsmanship

Format: 168 × 237, stron: 424

Poznaj najlepsze metody tworzenia doskona³ego kodu

Jak pisaæ dobry kod, a z³y przekszta³ciæ w dobry?

Jak formatowaæ kod, aby osi¹gn¹æ maksymaln¹ czytelnoœæ?

Jak implementowaæ pe³n¹ obs³ugê b³êdów bez zaœmiecania logiki kodu?

O tym, ile problemów sprawia niedbale napisany kod, wie ka¿dy programista. Nie

wszyscy jednak wiedz¹, jak napisaæ ten œwietny, "czysty" kod i czym w³aœciwie powinien

siê on charakteryzowaæ. Co wiêcej - jak odró¿niæ dobry kod od z³ego? OdpowiedŸ na te

pytania oraz sposoby tworzenia czystego, czytelnego kodu znajdziesz w³aœnie w tej

ksi¹¿ce. Podrêcznik jest obowi¹zkow¹ pozycj¹ dla ka¿dego, kto chce poznaæ techniki

rzetelnego i efektywnego programowania.

W ksi¹¿ce „Czysty kod. Podrêcznik dobrego programisty” szczegó³owo omówione

zosta³y zasady, wzorce i najlepsze praktyki pisania czystego kodu. Podrêcznik zawiera

tak¿e kilka analiz przypadków o coraz wiêkszej z³o¿onoœci, z których ka¿da jest

doskona³ym æwiczeniem porz¹dkowania zanieczyszczonego b¹dŸ nieudanego kodu.

Z tego podrêcznika dowiesz siê m.in., jak tworzyæ dobre nazwy, obiekty i funkcje,

a tak¿e jak tworzyæ testy jednostkowe i korzystaæ z programowania sterowanego

testami. Nauczysz siê przekszta³caæ kod zawieraj¹cy problemy w taki, który jest

solidny i efektywny.

Nazwy klas i metod

Funkcje i listy argumentów

Rozdzielanie poleceñ i zapytañ

Stosowanie wyj¹tków

Komentarze

Formatowanie

Obiekty i struktury danych

Obs³uga b³êdów

Testy jednostkowe

Klasy i systemy

Wspó³bie¿noœæ

Oczyszczanie kodu

Niech stworzony przez Ciebie kod imponuje czystoœci¹!

SPIS TREŚCI

Słowo wstępne

Wstęp

1. Czysty kod

Niech stanie się kod...

W poszukiwaniu doskonałego kodu...

Całkowity koszt bałaganu

Rozpoczęcie wielkiej zmiany projektu

Postawa

Największa zagadka

Sztuka czystego kodu?

Co to jest czysty kod?

Szkoły myślenia

Jesteśmy autorami

Zasada skautów

Poprzednik i zasady

Zakończenie

Bibliografia

2. Znaczące nazwy

Wstęp

Używaj nazw przedstawiających intencje

Unikanie dezinformacji

Tworzenie wyraźnych różnic

Tworzenie nazw, które można wymówić

Korzystanie z nazw łatwych do wyszukania

Unikanie kodowania

Notacja węgierska

Przedrostki składników

Interfejsy i implementacje

Unikanie odwzorowania mentalnego

Nazwy klas

Nazwy metod

Nie bądź dowcipny

Wybieraj jedno słowo na pojęcie

Nie twórz kalamburów!

Korzystanie z nazw dziedziny rozwiązania

Korzystanie z nazw dziedziny problemu

Dodanie znaczącego kontekstu

Nie należy dodawać nadmiarowego kontekstu

Słowo końcowe

3. Funkcje

Małe funkcje!

Bloki i wcięcia

Wykonuj jedną czynność

Sekcje wewnątrz funkcji

Jeden poziom abstrakcji w funkcji

Czytanie kodu od góry do dołu — zasada zstępująca

Instrukcje switch

Korzystanie z nazw opisowych

Argumenty funkcji

Często stosowane funkcje jednoargumentowe

Argumenty znacznikowe

Funkcje dwuargumentowe

Funkcje trzyargumentowe

Argumenty obiektowe

Listy argumentów

Czasowniki i słowa kluczowe

Unikanie efektów ubocznych

Argumenty wyjściowe

Rozdzielanie poleceń i zapytań

Stosowanie wyjątków zamiast zwracania kodów błędów

Wyodrębnienie bloków try-catch

Obsługa błędów jest jedną operacją

Przyciąganie zależności w Error.java

Nie powtarzaj się

Programowanie strukturalne

Jak pisać takie funkcje?

Zakończenie

SetupTeardownIncluder

Bibliografia

4. Komentarze

Komentarze nie są szminką dla złego kodu

Czytelny kod nie wymaga komentarzy

Dobre komentarze

Komentarze prawne

Komentarze informacyjne

Wyjaśnianie zamierzeń

Wyjaśnianie

Ostrzeżenia o konsekwencjach

Komentarze TODO

Wzmocnienie

Komentarze Javadoc w publicznym API

Złe komentarze

Bełkot

Powtarzające się komentarze

Mylące komentarze

Komentarze wymagane

Komentarze dziennika

SPIS TREŚCI

Komentarze wprowadzające szum informacyjny

Przerażający szum

Nie używaj komentarzy, jeżeli można użyć funkcji lub zmiennej

Znaczniki pozycji

Komentarze w klamrach zamykających

Atrybuty i dopiski

Zakomentowany kod

Komentarze HTML

Informacje nielokalne

Nadmiar informacji

Nieoczywiste połączenia

Nagłówki funkcji

Komentarze Javadoc w niepublicznym kodzie

Przykład

Bibliografia

5. Formatowanie

Przeznaczenie formatowania

Formatowanie pionowe

Metafora gazety

Pionowe odstępy pomiędzy segmentami kodu

Gęstość pionowa

101

Odległość pionowa

101

Uporządkowanie pionowe

105

Formatowanie poziome

106

Poziome odstępy i gęstość

106

Rozmieszczenie poziome

107

Wcięcia

109

Puste zakresy

110

Zasady zespołowe

110

Zasady formatowania wujka Boba

111

6. Obiekty i struktury danych

113

Abstrakcja danych

113

Antysymetria danych i obiektów

115

Prawo Demeter

117

Wraki pociągów

118

Hybrydy

118

Ukrywanie struktury

119

Obiekty transferu danych

119

Active Record

120

Zakończenie

121

Bibliografia

121

7. Obsługa błędów

123

Użycie wyjątków zamiast kodów powrotu

124

Rozpoczynanie od pisania instrukcji try-catch-finally

125

Użycie niekontrolowanych wyjątków

126

Dostarczanie kontekstu za pomocą wyjątków

127

Definiowanie klas wyjątków w zależności od potrzeb wywołującego

127

SPIS TREŚCI

Definiowanie normalnego przepływu

129

Nie zwracamy null

130

Nie przekazujemy null

131

Zakończenie

132

Bibliografia

132

8. Granice

133

Zastosowanie kodu innych firm

134

Przeglądanie i zapoznawanie się z granicami

136

Korzystanie z pakietu log4j

136

Zalety testów uczących

138

Korzystanie z nieistniejącego kodu

138

Czyste granice

139

Bibliografia

140

9. Testyjednostkowe

141

Trzy prawa TDD

142

Zachowanie czystości testów

143

Testy zwiększają możliwości

144

Czyste testy

144

Języki testowania specyficzne dla domeny

147

Podwójny standard

147

Jedna asercja na test

149

Jedna koncepcja na test

150

F.I.R.S.T.

151

Zakończenie

152

Bibliografia

152

10. Klasy

153

Organizacja klas

153

Hermetyzacja

154

Klasy powinny być małe!

154

Zasada pojedynczej odpowiedzialności

156

Spójność

158

Utrzymywanie spójności powoduje powstanie wielu małych klas

158

Organizowanie zmian

164

Izolowanie modułów kodu przed zmianami

166

Bibliografia

167

11. Systemy

169

Jak budowałbyś miasto?

170

Oddzielenie konstruowania systemu od jego używania

170

Wydzielenie modułu main

171

Fabryki

172

Wstrzykiwanie zależności

172

Skalowanie w górę

173

Separowanie (rozcięcie) problemów

176

Pośredniki Java

177

SPIS TREŚCI

Plik z chomika:

Inne pliki z tego folderu:

Inne foldery tego chomika: