Tips för laborationerna
Först och främst: om du hittar någon nyttig sak i någon .h-fil, så inkludera
den .h-filen i ditt program. Kopiera aldrig information ur .h-filer till din
källkod!
Lämna inte in några disketter!
Låt istället källkoden ligga på din användare och hänvisa till filerna med deras
sökväg. Tänk på att filerna måste vara läsbara vid inlämningstillfället.
Anledningen till detta är att en del Unix-maskiner inte har diskettstation.
Dessutom går det snabbare att rätta labbarna om man inte behöver krångla med
disketter.
Vill du få din laboration godkänd?
Tänk då på att:
-
Rapporten är en stor och viktig del av en laboration. Den ska göras
enligt den anvisning för laborationsredovisning som delats ut.
Tänk på hur du skriver, vi kommer att titta på språk och stavning.
Uttryck dig inte luddigt, det kan tolkas som att du inte riktigt
förstår vad det är du skriver.
Kom också ihåg att kvalitet går före kvantitet.
-
Kommentera koden, använd dig inte av devisen "It was hard to write, it
should be hard to read".
-
Gör ett anropsdiagram om ditt program består
av mer än ett fåtal funktioner.
-
Redovisa algoritmer som inte är välkända för dig.
-
Använd funktionshuvudskommentarer i koden,
det underlättar läsning av din kod.
-
Kom ihåg att alla labbar ska vara godkända senast onsdag den 3:e
november 1999 kl. 23:59, annars måste du göra omlabbar under julhelgen.
-
Koden ska ligga i ~/edu/sysprog/labx, där x är labbens nummer.
Kom ihåg att döpa filerna till det som specificerats i
laborationsspecifikationen. Vi har varken tid, lust eller ork att leta
igenom din hemkatalog efter filer. Dessutom skjuter sig våra
rättnings-skript stenhårt i foten om de inte kan hitta dina filer.
Labbrapporternas utformning
Det finns ett
mer
omfattande dokument som beskriver hur labbrapporterna ska vara utformade,
tyvärr lite föråldrat men bra att ha om du tycker dessa anvisningar är för
kortfattade. Vi kräver inte att alla rubriker ska finnas med i alla rapporter,
bedöm själv vad som är rimligt (och håll tummarna för att den som rättar labben
gör samma bedömning).
-
Försättsbladet ska innehålla kursens namn och termin, datum,
laborationens nummer, studentens namn och användar-id på CS,
vilken inlämning det är (första, omlabb etc.) och handledarnas namn.
-
Innehållsförteckning är lämpligt att ha med om rapporten har mer
än ett fåtal sidor.
-
Under rubriken åtkomst och användarhandledning talar du om var
ditt program ligger, hur man startar det och hur det används. Det är
även ett bra ställe att tala om hur man gör för att kompilera ditt
program, vilket kan vara användbart om vi behöver göra ytterligare
tester.
-
I problemspecifikationen beskriver du uppgiften med egna
ord. Det är ingen idé att kopiera detta stycke direkt från
labbspecen. Om du absolut inte orkar skriva en egen
problemspecifikation, hänvisa till labbspecen, bifoga en utskrift av
den som bilaga eller utelämna rubriken helt.
-
Systembeskrivningen är till för att beskriva eventuella
egendefinierade datatyper samt hur
anropsstrukturen ser ut. Här bör du också
beskriva vilka funktioner som finns i ditt program och vilka parametrar
de tar m.m.
-
Algoritmbeskrivningen innehåller beskrivningar av algoritmer som
inte är självklara.
-
Under rubriken lösningens begränsningar anger du eventuella
begränsningar som finns i din implementation, exempelvis "min databas
kan inte hantera mer än 10,000 poster" eller "min implementation
beräknar inte imaginära lösningar".
-
Problem och reflektioner är en viktig rubrik. Här talar du om
vilka problem som uppstod under arbetet och hur du löste dem. Berätta
gärna vad du tyckte om laborationen. Du kan också ge synpunkter på
handledningen här, om du tycker att det verkar lämpligt.
-
Utskrifter från testkörningar i någon form vill vi gärna ha med. Om
du skrivit ett eget testprogram bör du dessutom bifoga koden till
testprogrammet under rubriken Källkod.
-
Källkod ska finnas med, snyggt utskriven med ett
icke-proportionellt typsnitt (exempelvis Courier). Vi rekommenderar
atp -C
eller genscript
.
Utskrift av källkod
Använd kommandot
atp -C <filnamn> | lpr -P <skrivare>
för att skriva ut källkod som skall lämnas in, och kalla utskriften
"bilaga" i rapporten. Det är visserligen inte så snyggt men det är
mycket bättre än grå textmassa som har tappat sin ursprungliga indentering.
Exempel:
ath@krom% atp -C *.c | lpr -Pma446ps
[an error occurred while processing this directive]