TDDC76 Programmering och datastrukturer

Kodmallar för laborationer

Då det gäller laborationer räcker det med sparsammare kommentering i koden, än vad som anges i Kodmallar.

För en fil som innehåller ett huvudprogram, eller en klassdefinition, eller är en inkluderingsfil, ska en strategisk kommentar enligt följande finnas först i filen:

/*
 * FILNAMN:       filens namn
 * LABORATION:    laborationens nummer
 * PROGRAMMERARE: namn pnr klass
 *                namn pnr klass
 * DATUM:         2003-mm-dd
 *
 * BESKRIVNING 
 * 
 * Kort beskrivning av programmet/klassen/inkluderingen
 */

#include <*>
#include "*.h" 

eventuella funktionsprototyper som relaterar till 
funktioner längre ner i filen.

int main()
{
   ...
}

eventuella övriga funktioners definitioner

Inkluderingsfiler, förutom inline-definitionsfiler, och klassdefinitioner behöver inte ha några ytterligare kommentarer utöver den strategiska kommentaren överst i filen.

En implementeringsfil (*.cc) eller en inline-definitionsfil (*.icc) ska först i filen ha en kommentar enligt följande.

/*
 * FILNAMN:       filens namn
 * LABORATION:    laborationen nummer
 * PROGRAMMERARE: namn pnr klass
 *                namn pnr klass
 * DATUM:         2003-mm-dd
 */

Funktionsdefinitioner som finns i filen kommenteras enligt nedan. Annat substansiellt, t ex datatypsdefinitioner kommenteras också på lämpligt sätt.

Varje funktionsdefinition, utom main(), förses med en strategisk kommentar:

/*
 * FUNKTION f(...) 
 *
 * Kort beskrivning av vad funktionen gör
 */

T f(...)
{

}

Utöver detta kan man översiktligt kommentera deluppgifter som utförs i funktioner, genom att sätta in en kommentar ovanför avsett kodavsnitt med samma indrag från vänstermarginalen som kodavsittet ifråga.

För övrigt räknar vi med att omsorgsfull namngivning eliminerar behovet av ytterligare kommentarer i dessa relativt enkla program.

Sidansvarig: Jonas Lindgren
Senast uppdaterad: 2015-08-18