Opieka nad projektem...
Jakiś czas temu dostałem łatę na JJIGW dodającą obsługę subskrypcji obecności użytkowników IRCa. Rzecz fajna, przydatna, aczkolwiek z powodu specyfiki IRCa (zmieniające się nicki), ciężka do zaimplementowania.
Dzisiaj wreszcie znalazłem czas, żeby przejrzeć tego patcha. I nie
spodobał mi się. Parę rzeczy psuł (łamiąc specyfikację XMPP i MUC), parę innych robił nia tak jakbym
chciał. Ale zawierał też pewne poprawki mojego kodu. Najbardziej dokuczyły mi:
brak dokumentacji dodanego kodu i coding style
. Ale tego nie
śmiałem się za bardzo czepiać — mój kod JJIGW sam
z siebie jest kompletnie pozbawiony dokumentacji, a i śliczny nie jest.
Napisałem swoje uwagi do autora patcha. W sumie, nawet jakby nie chciał tego poprawić, to bym patcha nałożył. Ręcznie, w większości po swojemu, ale dodałbym te zmiany. Jednak gotowy kod, to zawsze coś. Szkoda, że rzadko dostaję gotowe ulepszenia do moich projektów. No, ale cóż. Sam sobie też jestem winien — komu się chce grzebać w zawiłym i nieudokumentowanym kodzie? Z drugiej strony, jakbym się uparł, żeby wszystko udokumentować, to ten kod by pewnie w ogóle nie powstał — zabawa mogłaby przestać być zabawna. Dobrze, że przynajmniej API PyXMPP jakoś udokumentowałem.
Śledzenie komentarzy (RSS)
17 lipca 2005 22:03:56
Nieudokumentowany kod (obojętne, w postaci binarnej czy źródłowej) nie nadaje się do użytku.