Spis treści Poprzednia strona: Programowanie modularne Następna strona: Podstawy

Odnajdywanie istniejących rozwiązań wymaga w dużej mierze po prostu znajomości języka angielskiego i umiejętności czytania i używania cudzego kodu. Dlatego tak ważne jest aby od samego początku programiści stosowali tzw. dobry styl programowania, polegający na podobnym wyglądzie kodu, odpowiednich wcięciach, komentarzach w kodzie wyjaśniających jego działanie i standardowych sposobach wykonywania standardowych czynności. Bez przerwy należy mieć na uwadze taką możliwość, że ktoś inny być może będzie chciał kiedyś skorzystać, z tego co napisaliśmy. Nie koniecznie robimy to dla kogoś innego, ale często także dla siebie samego, kiedy na przykład wracamy do danego fragmentu kodu po kilku latach i nie pamiętamy już ani jak on działa, ani co on robi. Wtedy odpowiedni komentarz jest bezcenny. Jeśli kod będzie napisany w złym stylu, to jego ponowne wykorzystanie stanie się albo niemożliwe, albo nieopłacalne (za dużo czasu może wymagać jego zrozumienie). Jeśli piszemy kod w postaci tzw. „czarnej skrzynki”, to nie interesuje nas jak on działa wewnętrznie. Aby z niego ponownie skorzystać potrzebna jest tylko dokładna dokumentacja opisująca samo wykorzystywanie, czyli dokładny opis znaczenia i typów danych wejściowych oraz wyjściowych, a także sposób przekazywania i odbierania tych danych. Nie oznacza to jednak, że można zrezygnować z komentowania kodu wewnątrz, bo nigdy nie ma gwarancji, że nie będziemy musieli do niego wrócić (bo na przykład zmieniła się technologia i usunięto z języka, albo z samych procesorów określone instrukcje uznane jako nieefektywne albo już niepotrzebne i przestarzałe). Dokumentacja to więc nie to samo, co komentarz, ale istnieją też techniki używania komentarzy do automatycznego tworzenia dokumentacji. Język C# używa takiej właśnie techniki domyślnie, co pozwala „upiec dwie pieczenie na jednym ogniu”: dokumentację wewnętrzną i zewnętrzną.

Spis treści Poprzednia strona: Programowanie modularne Następna strona: Podstawy