All we do is looking for some way to fulfill our needs.

czwartek, 19 czerwca 2008

Tagged under: ,

Porządki w kodzie czyli nie tylko o refaktoringu

Blogspot niestety rozczarowuje mnie pod kątem publikowania kodu źródłowego, co jest szczególnie ważne w przypadku tematów poruszających styl kodowania. Być może ktoś z was ma jakieś doświadczenia lub pomysły w tej kwestii. Ja używam narzędzia http://formatmysourcecode.blogspot.com/2006/02/paste-your-text-here.html, ale mimo wszystko blogspot raz na jakiś czas deformatuje posta :/

Poniżej zamieszczam cały artykuł poświęcony porządkom w kodzie - poprawnie sformatowany.


Tutaj możesz pobrać pełną wersję PDF artykułu

5 komentarze:

KosciaK pisze...

Świetny tekst!
Kilka rzeczy dało mi do myślenia jak np jawne nazywanie warunków ifów - automatycznie nazwa zmiennej staje się komentarzem.

Mam jednak uwagę do przykładu eliminowania powtórzeń (str 19 w PDFie). Skoro i tak w Constructor(String) robisz this(int, String) to po co w obu tych konstruktorach initializeBitSet()? i tak zostanie wykonana w wywołanym przez this konstruktorze

A i jeszcze malutka uwaga co do samego layoutu bloga - nie dałoby się trochę szerzej? 400px jako szerokość tekstu to moim zdaniem strasznie mało.

Mariusz Sieraczkiewicz pisze...

Tak, zgadzam się ;-), wbrew powszechnie panującym opiniom można tworzyć samodokumentujący się kod, który ładnie wygląda, a jego pisanie zajmuje tyle samo czasu co pisanie brzydkiego kodu. Za to łatwość i przyjemność czytania jest ... bezcenna.

Masz zdecydowanie rację, co do uwagi odnośnie konstruktora - wywołanie initializeBitSet spowoduje drugie wywołanie tej metody. Wkradł się błąd postaram się bo poprawić w wolnym czasie.

Z blogspotem jeszcze walczę, mam nadzieje, że w niedługim czasie uda mi się pokonać wszystkie jego niedogodności.

jau pisze...

Dodatkowa wskazwówka:

Używaj tam gdzie się da zmiennych finalnych. Daje to czytelnikowi pewność, że zawartość zmiennej się nie zmieni.

KosciaK pisze...

Mniejsza o czytelność, mniejsza o estetykę, mniejsza o przyjemność czytania. Ważne jest to, że siadając po pół roku do swojego kodu można go (szybko) zrozumieć a nie rzucać co chwilę "WTF!?!" :)
Dlatego nie jestem w stanie zrozumieć osób, które wszystkie zmienne nazywają jednoliterowo i na siłę stosują "mastahakierskie" skróty i sztuczki.

koper pisze...

Bardzo pożyteczny wpis :-). Jestem raczej początkującym programistą i wszelkie rozsądne uwagi nt. kodowania staram się wcielać w życie. Ku mojemu zadowoleniu - wiele z Twoich podpowiedzi stosuję od zawsze, jakoś tak intuicyjnie.

Natomiast mam opory dot. nazywania warunków if'ów. Ja w takich przypadkach zawsze - bądź prawie zawsze ;) - stosuję stary dobry komentarz.

Jeszcze to przemyślę. Pozdrawiam.