[wodzik]

#heheszki #humorinformatykow #programowanie #programista15k

[mag_zbc]

@wodzik:

A guy opens his pull request and gets a decline, you think that of me? No. I am the one who declines!

[Krolik]

@wodzik: ktoś z Was pracował kiedyś przy projekcie który miał dobrą dokumentację, zwłaszcza dobrą dokumentację w kodzie?

[galencjusz]

@Krolik: dobry kod sam się dokumentuje ( ͡° ͜ʖ ͡°)

[MartinPL]

@wodzik: wersja z kodem zamiast Waltera też byłaby spoko :D

[Krolik]

@galencjusz: bullshit, za dużo się uncle boba naczytałeś

[y.....l]

@Krolik: Tak, ale trzeba było nad ludźmi z batem siedzieć, żeby robili dokumentację. To wszystko zależy od polityki firmy. Jak pracujesz w SH, gdzie trzeba szybko, byle task zamknąć to dokumentacji nie ma. ;)

[Krolik]

@galencjusz: a sorry, za szybko odpisałem, to był sarkazm

[M.....l]

@Krolik: dobry kod sam się dokumentuje ( ͡° ͜ʖ ͡°)

@galencjusz: ta, zdokumentuj se w kodzie architekturę albo zasady czy narzędzia użyte w projekcie XD

[t.....i]

@Krolik: czy ja wiem czy tak do końca bullshit, pracuję w projekcie gdzie jestem jedynym midem, a cała reszta teamu to seniorzy i polityka jest tu taka, że w PR p------------ą się o dosłownie wszystko, czasem po trzy razy musiałem zmieniać nazwę metody XD Efekt jest faktycznie taki, że kod jest zajebiście czytelny i wujek Bob mógłby pałować do <10-liniowych metod i <100-liniowych klas, otwierasz dany serwis i dość szybko

[Krolik]

@taraqui: samodokumentowanie się kodu jest możliwe w ograniczonym zakresie, mocno zależnym od ekspresywności języka, w którym się pisze. Wielu rzeczy nie da się wyrazić inaczej jak komentarzem.

[Quiz]

@taraqui: w jakiej technologii piszesz?

[t.....i]

@Krolik: @Quiz: no fakt, nie pomyślałem o różnych językach, jak na wykopka przystało założyłem że skoro piszę w dżawie, to każda dyskusja o programowaniu dotyczy dżawy XD Szybko poszło

[Krolik]

@taraqui: w Javie? :D :D :D No to przykładowo masz konstruktor obiektu Index w takiej Javie, który otwiera przekazany plik: Index(FileHandle file) { ... }. Kto zamyka FileHandle? Ten kto utworzył obiekt Index, czy może Index sam zamknie po użyciu? Odpowiedz bez zaglądania w implementację i bez czytania komentarzy. :D

Drugie pytanie: dostałeś od kolegi Javową strukturę UltraFastHashMap. Możesz użyć ją w wielu wątkach czy nie? Znowu

[Krolik]

@taraqui: Istotą dokumentacji nie jest to, aby umożliwić zrozumienie co robi dany kod, bo ostatecznie każdy kod da się przeczytać w skończonym czasie i podejrzeć co robi, tylko umożliwienie pracy z kodem *bez konieczności czytania całości*. A brak czytania kodu zajmuje zawsze mniej czasu niż czytanie choćby najlepszego samodokumentującego się kodu.

[t.....i]

@Krolik: mordo ale z czym Ty wyskakujesz, ja Ci mówię o pisaniu kodu, który nie wymaga dokumentacji, a Ty mi podajesz przykład z javowej biblioteki, która z założenia takową dokumentację posiada XD

Istotą dokumentacji nie jest to, aby umożliwić zrozumienie co robi dany kod, bo ostatecznie każdy kod da się przeczytać w skończonym czasie i podejrzeć co robi, tylko umożliwienie pracy z kodem bez konieczności czytania całości. A brak czytania

[Krolik]

@taraqui: Podane przykłady nie są z żadnej biblioteki Javy, a z kodu napisanego w rzeczywistym projekcie (zmienione są tylko minimalnie nazwy). No i skoro Javowa biblioteka standardowa dokumentację posiadaj, to imputujesz że twórcy Javy nie umieli w samodokumentujący się kod. No bo jakby umieli, to dokumentacja nie byłaby potrzebna, co nie?

[c.....c]

@Krolik: (zakładając, że nie masz żadnego di) to co do zasady implementacje Cloesable dawałbym w try-with-resources

try (var fileHandle = new FileHandle()) {
 new Index(fileHandle);
}

[Krolik]

@czwarta_gestosc: No i w ten sposób możesz doprowadzić do błędu, bo skąd wiesz, czy Index nie przekaże tego FileHandle dalej i powinien być otwarty po tym jak Index zostanie zamknięty? Zrobiłeś założenie że Index nie jest ownerem FileHandle, a jedynie sobie tego handla pożycza. A tak naprawdę nie wiesz, bo nie przeczytałeś dokumentacji, albo dokumentacji nie było :P

Sorki, Java jest za mało ekspresywnym językiem aby wyrazić koncepcję "obiekt X