DAT 501 [adm1]
Riktlinjer för OOP inlämningsuppgifter
Inlämning
Redogörelsen läggs i avsett fack i skåpet i trapphuset utanför sekreterarens rum.
Varje gång du lämnar in en redogörelse skall du också använda ett försättsblad som har delats ut på kursen. Se avsnittet om redogörelsen.
Programmeringsuppgiften måste lämnas in i tid. Om man missar sista inlämningsdag finns det ingen anledning att lämna in denna uppgift.
Underkända uppgifter
Uppgiften underkänds om den inte lämnas in i tid, eller om programmet, rapporten eller bådadera underkänts. I så fall får man göra respektive kompletteringsuppgift (make-up exercise). Missar man också denna så får man vänta till nästa kurstillfälle.
Hjälp och fusk
Eftersom programmeringsuppgiften är en del av examinationen på kursen så gäller samma regler för dessa som för den skriftliga tentamen vad gäller fusk.
Institutionen har en separat sida om hjälp och fusk:
Redogörelse
Försättsblad
Den som rättar din uppgift testkör programmet för att kontrollera att det fungerar. Programmet måste därför finns tillgängeligt i exekverbar form. Ge namnet på den exekverbara filen på försättsbladet.
- Observera att de filer som skall kunna köras eller läsas av granskeren måste ha de nödvändiga rättigheter. De måste vara läs- och exekverbar för others.
På försättsbladet kommer också ditt betyg på uppgiften att registreras. Behåll dessa tills dess att du har fått ut ditt examensbevis för kursen.
Uppdelning
Redovisningen skall skrivas enligt följande mall:
- 1. Problemformulering.
- Beskriv problemet kortfattad. Om du löser ett problem från boken, så räcker det att skriva t ex «Uppgift 3.10:4 i Schmidt: Programming Principles i Java». Om du har gjort ytterligare avgränsningar eller preciseringar av uppgiften, beskrivs dessa här.
- 2. Användarhandledning
- Förklara hur programmet startas, vilka funktioner som finns, vilken inmatning som kan göras, etc. Texten skall vända sig till en användare som har grundläggande kunskap om datorer. Skriv kort.
- 3. Programstruktur.
- Beskriv hur du har vald att strukturera problemet. Om delar av strukturen är givna i uppgiftsformuleringen finns det ingen anledning att upprepa eller motivera detta. Du måste använda dig av bokens sätt att rita klassdiagrammer (fast du får använda ett ritprogram om du vill snygga till dem). Du måste även producera javadoc-dokumentation för dina offentliga klasser och metoder (se [S] 5.9.2), som inte bifogas, men vars adress anges på försättsbladet.
- 4. Test
- Ange om din kod kompileras med eller utan varningar och fel.
Beskriv hur du har testad programmet. Rapportera allt felaktigt eller icke-önskvärd beteende.
- 5. Brister och kommentarer
- Om ditt program inte fungerar, försök att förklara det här. Kommentera sådant som du skulle ha gjort annorlunda om du hade haft tid. Här finns också plats till ytterligare kommentarer till uppgiftens formulering och storlek. Denna del av dokumentationen är avsedd för granskaren.
Det finns et exempel på en redogörelse:
Bilagor
Du måste bifoga
- Utskrift av din egen programkod. Koden skall vara väl formatterad, kommenterad och lätt att förstå.
- Dokumentation av testkörningarna. Försök att begränsa omfånget av dessa till en sida. Om ditt program till exempel producerar grafiskt output räcker det med en eller två skärmbilder, typisk av de intressanta fallen. Har du producerad ett särskilt testprogram, bifoga detta. Om du däremot 200 testkörningar, så föredrar vi ett länk till testfilen och resultatet framför en utskrift.
Speciellt skall du skall inte bifoga utskrift av javadoc-dokumentationen.