TheTarPit

dokumentacja kodu

Pracowałem kiedyś przy projekcie, w którym robiłem pewien moduł w znacznym stopniu niezależny od reszty systemu (sam go zaprojektowałem i sam zaprogramowałem), mogłem więc obserwować całość z boku. W sumie działało tam ośmiu programistów, o różnym stażu, różnych doświadczeniach i umiejętnościach, nawet rozmieszczonych w niemal krańcowo odległych lokalizacjach w Polsce. Oprócz mnie może jeszcze jedna osoba tworzyła w kodzie komentarze dla zwiększenia jakości kodu, a nie dla wyrażenia swoich frustracji. Oprócz mojego żaden moduł programu nie posiadał kompletu własnej dokumentacji. A całość była pisana w javie, więc stworzenie sensownej i kompleksowej dokumentacji kodu (z użyciem Javadoc) wymagało jedynie odrobiny dobrej woli...