Wpis z mikrobloga

@wodzik: Ja dostałem odpowiedź, "Code speaks for itself" xD. Imo main features powinny mieć jakieś notatki i wyjaśniena. Takie core punkty dla biznesu. Wiadomo, że szczegółowa dokumentacja nie ma sensu. Ale wszystko o co klient (zewn czy wewn) może zapytać powinno być w dokumentacji.
  • Odpowiedz
bo skąd wiesz, czy Index nie przekaże tego FileHandle dalej i powinien być otwarty po tym jak Index zostanie zamknięty?


@Krolik: trochę niejasno piszesz, o ile Cię dobrze rozumiem to żeby tak się stało to musiałby przekazać do innego threada
  • Odpowiedz
@taraqui: Chciałem Ci pokazać, że bardzo wielu istotnych własności kodu nie jesteś w stanie udokumentować samym kodem, a cała dyskusja jest o tym że "dobry kod sam się dokumentuje". Dobry kod dokumentuje się co najwyżej częściowo. Sygnatury metod nawet w Javie często są niewystarczające aby na ich podstawie stwierdzić jak poprawnie użyć kodu.
  • Odpowiedz
podałeś przykład klasy która została okraszona dokumentacją, teraz zabierasz dokumentację i pałujesz że hurr durr nie da się nic zrozumieć bez dokumentacji


@taraqui: niezupełnie, w Javie nie da się zdefiniować metody przyjmującej jakiś zasób (niech będzie FileHandle ale może być cokolwiek innego) tak aby *bez czytania dokumentacji* użytkownik wiedział jak jej bezpiecznie użyć. Po prostu w takim przypadku musisz mieć dokuementację, bo sam język nie jest wystarczająco ekspresywny.
  • Odpowiedz