Přejít k navigační liště

Zdroják » Zprávičky » Tvoříme programátorskou dokumentaci

Tvoříme programátorskou dokumentaci

Zprávičky Různé

Nálepky:

Každý, kdo kdy psal nějaký kód, určený pro ostatní vývojáře, zákonitě narazil na otázku dokumentace. Jak má vypadat, co v ní má být, jakou formou…? Kvalitní dokumentace může vaši knihovnu protlačit mezi lidi, nebo naopak totálně pohřbít, možná spolehlivěji než kvalita či nekvalita vlastního kódu. Nad problémy spojenými s tvorbou programátorské dokumentace se zamýšlí Jan Novotný na svém blogu.

Komentáře

Subscribe
Upozornit na
guest
4 Komentářů
Nejstarší
Nejnovější Most Voted
Inline Feedbacks
View all comments
vd

„nějakou kód“ ? :)

novoj

Hmm, bohužel za tenhle překlep může redakce, která upravila mnou původně navrhovaný text. Bohužel už nemám právo to zpětně korekturovat, takže s tím nemůžu nic udělat. Bude se to tedy muset přežít ;-)

Martin Malý

Redakce děkuje za upozornění a autorovi se omlouváme…

novoj

Díky moc, já děkuju hlavně za rychlé zveřejnění. Překlep se prostě přihodí ani člověk neví jak.

Enum a statická analýza kódu

Mám jednu univerzální radu pro začínající programátorty. V učení sice neexistují rychlé zkratky, ovšem tuhle radu můžete snadno začít používat a zrychlit tak tempo učení. Tou tajemnou ingrediencí je statická analýza kódu. Ukážeme si to na příkladu enum.