Zpo-8-wyk-Slajd34: Różnice pomiędzy wersjami
Nie podano opisu zmian |
Nie podano opisu zmian |
||
| Linia 1: | Linia 1: | ||
== | ==Comments== | ||
[[Image:zpo-8-wyk-Slajd34.PNG| | [[Image:zpo-8-wyk-Slajd34.PNG|Comments]] | ||
Nadmiar komentarzy jest zapachem o niewielkiej dokuczliwości, ale warto o nim wspomnieć, ponieważ budzi on naturalne i zrozumiałe kontrowersje. Pełne dokumentowanie kodu źródłowego jest przecież oczywistym postulatem inżynierii oprogramowania; zaleca się programistom, aby komentowali każdą istotną decyzję odpowiednią adnotacją. | |||
Nadmiarem komentarzy nazywana jest sytuacja, w której komentarz zawiera dokładnie te same informacje i na tym samym poziomie czytelności, co sam kod źródłowy. W ten sposób komentarz staje się niepotrzebnym duplikatem, który sam w sobie wymaga pielęgnacji i aktualizacji. | |||
Jeżeli struktura kodu jest tak skomplikowana, że wymaga rozbudowanego komentarza, wówczas konieczna jest jej modyfikacja. Podstawowym rozwiązaniem jest, jak w wielu podobnych przypadkach, utworzenie nowej metody. Bardzo ważne jest nazewnictwo metod, aby intuicyjnie odzwierciedlało ono zadania stojące przed metodą. Czasem czytelność jest wzmacniana poprzez wprowadzenie asercji, która w odróżnieniu od komentarza jest weryfikowana w momencie wykonywania programu, a jej naruszenie jest zgłaszane programiście. | |||
[[zpo-8-wyk-Slajd33 | << Poprzedni slajd]] | [[zpo-8-wyk-toc|Spis treści ]] | [[zpo-8-wyk-Slajd35 | Następny slajd >>]] | [[zpo-8-wyk-Slajd33 | << Poprzedni slajd]] | [[zpo-8-wyk-toc|Spis treści ]] | [[zpo-8-wyk-Slajd35 | Następny slajd >>]] | ||
Aktualna wersja na dzień 18:14, 4 lis 2006
Comments
Nadmiar komentarzy jest zapachem o niewielkiej dokuczliwości, ale warto o nim wspomnieć, ponieważ budzi on naturalne i zrozumiałe kontrowersje. Pełne dokumentowanie kodu źródłowego jest przecież oczywistym postulatem inżynierii oprogramowania; zaleca się programistom, aby komentowali każdą istotną decyzję odpowiednią adnotacją.
Nadmiarem komentarzy nazywana jest sytuacja, w której komentarz zawiera dokładnie te same informacje i na tym samym poziomie czytelności, co sam kod źródłowy. W ten sposób komentarz staje się niepotrzebnym duplikatem, który sam w sobie wymaga pielęgnacji i aktualizacji.
Jeżeli struktura kodu jest tak skomplikowana, że wymaga rozbudowanego komentarza, wówczas konieczna jest jej modyfikacja. Podstawowym rozwiązaniem jest, jak w wielu podobnych przypadkach, utworzenie nowej metody. Bardzo ważne jest nazewnictwo metod, aby intuicyjnie odzwierciedlało ono zadania stojące przed metodą. Czasem czytelność jest wzmacniana poprzez wprowadzenie asercji, która w odróżnieniu od komentarza jest weryfikowana w momencie wykonywania programu, a jej naruszenie jest zgłaszane programiście.
