On Dec 22, 10:18 am, Roman W <b...@g...pl> wrote:
> On Thursday, December 22, 2011 10:11:51 AM UTC, Andrzej Jarzabek wrote:
> > On Dec 22, 8:53 am, Roman W <b...@g...pl> wrote:
> > > On Thursday, December 22, 2011 1:25:33 AM UTC, Andrzej Jarzabek wrote:
> > > > Już nic, bo zanim wyszedłem z pracy zdążyłem zaimplementować to, czego
> > > > notatka dotyczyła. Sama notatka jest już w śmietniku.
>
> > > To na czym ma polegac osoba, ktora przejmuje taki kod? Tylko na komentarzach?
>
> > Tego kodu akurat nikt nie przejmie. Prawdopodobnie za jakieś trzy
> > tygodnie zostanie wykonany raz w produkcji i odłożony do lamusa.
>
> > W ogólnym przypadku polega się przede wszystkim na czytelnym kodzie i
> > czytelnych testach.
>
> IMHO to jest za malo.

Bywa, ale często wystarczy. Wracając do kontekstu: jeśli zamiast
trzech słów notatki, na podstawie której będziesz tworzyć
implementację tego samego dnia, lub w tym samym tygodniu, napiszesz
pięciostronicowy dokument w ten sposób, żeby mógł go zrozumieć i
implementację zrobić ktoś inny, a następnie zrobisz tę implementację
sam, to z konieczności w takim pięciostronicowym dokumencie znajdzie
się wiele informacji, która będzie redundantna, o ile piszesz czytelny
kod i testy. Jeśli napiszesz trzy słowa notatki, potem testy i
implmenetację, a to, czego nie potrafisz wyrazić w testach i kodzie,
umieścisz w komentarzach lub w dokumencie, to łączna ilość wysiłku nie
jest taka sama, bo unikniesz pracochłonnego zapisywania znacznej
części informacji dwa razy - w dokumencie w języku naturalnym
(pseudokodzie, diagramie itd) i drugi raz w kodzie. A przede wszystkim
omijasz problem potencjalnie uciążliwego procesu synchronizacji
dokumentacji i kodu (lub przynajmniej znacznie zmniejszasz jego
uciążliwość).