Re: [elmo-users] podzia³ ¼róde³

[Artur Skura]

On Mon, 05 May 2003 21:19:15 +0200, rzyjontko wrote:
r> A brak dokumentacji?  Good hackers don't write good documentation :)
r> Ale staram się.  Wiem, że powinienem się starać bardziej, ale na
r> bardziej brakuje czasu.  To wszystko dlatego, że pisanie dokumentacji
r> wydaje się marnowaniem czasu.  Przecież zamiast dokumentacji lepiej
r> jest napisać jeszcze jeden fajny kawałek kodu :) 

Och masz rację, ale takie choć kilka słów przed daną funkcją
co ona robi...

r> InnÄ… przyczynÄ… dla
r> której ciężko jest się zmusić do napisania dokumentacji jest fakt, że
r> ja z niej korzystać nie będę.  Wolę zajrzeć do kodu funkcji, żeby
r> zobaczyć jak działa.  I dotyczy to nie tylko tego co napisałem, ale
r> jest to taka generalna zasada.  Jak poprawiałem libtrasha, to nawet
r> nie zerknÄ…Å‚em na jedno zdanie w (bardzo bogatych) komentarzach.

O, o. Pomyśl, że są też zdolni inaczej, jak np. ja.
Typow przykłąd: widzę _jak_ funkcja robi to co robi, po nazwach
domyślam się też _co_ robi (czy też może w jakim celu), ale czasem
nie jest to aż-tak-oczywiste-jak-by-być-mogło. 

r> Many do funkcji wewnętrznych to może lekka przesada, ale dokumentacja
r> powinna być.  Będę się starał umieszczać kolejne moduły (nad którymi
r> praca jest już albo skończona, albo prawie skończona) do texinfo.  Z
r> tego można potem wygenerować htmla i np. umieścić na stronie.

:)

Pozdrowienia,
Artur
--
http://www.amnesty.org.pl