Fejl, Debugging, Test og Dokumentation
- slide 21 : 25
Dokumentation af Funktioner
Programdokumentation er naturlig engelsk eller dansk tekst, som fastholder forståelsen af et stykke program
Programdokumentation i et C program
Skrives som kommentarer:
Delimited comments:
/* ... */
- Kan ikke indlejres
Single line comments:
// ...
- Ikke ANSI C
Kan knyttes til program-dele på forskellige niveauer:
Udvalgte detaljer - enkelte kommandoer eller erklæringer
Sektioner af kommandoer og erklæringer
Funktioner - forklaring af en funktion, herunder funktionens input og output
Hele programmet - beskrivelse og forklaring af programmet som helhed
Kan ved brug af et dokumentationsprogram trækkes ud af C kildeprogrammet, og præsenteres som et separat dokument
Doxygen kan anbefales
![Forrige side: Dokumentation af Funktioner [Section] -- Tastaturgenvej: 'p'](./images/nav-left.gif "Forrige side: Dokumentation af Funktioner [Section] -- Tastaturgenvej: 'p'")
