Previous achievement | Next achievement

( D. Dokumentation )

D9

Dokumentation

Level Assessment
3 L

Dokumentera icke-triviala modulers gränssnitt så att någon utomstående kan programmera mot dem.

Bra dokumentation är av största vikt vid utveckling. Vid en kort kurs som denna är det svårt att uppleva nyttan med dokumentation som man själv skriver eftersom det inte hinner gå tillräckligt lång tid under kursen för att sådant man utvecklat skall falla tillräckligt i glömska. (Ta gärna fram någon gammal inlämningsuppgift i Haskell från PKD och försök följa logiken och ändra i den.)

I funktionella språk som Haskell är pre- och postvillkor bra sätt att dokumentera förväntningar och löften på ett sätt som inte exponerar onödiga detaljer. Javaprogram har i regel tonvis med sido-effekter -- vad får det för konsekvens för pre- och postvillkor?

Ge gärna kommentarer och rapportera buggar (klicka på den senaste commiten)

Edit | Back