Dokumentation |
forrige | næste |
Indholdsfortegnelse
Dokumentation hører desværre til de mere oversete ting i programmering. Alligevel så yder korrekt oprettet og vedligeholdt intern og ekstern dokumentation, yderst værdifuld hjælp.
Dokumentation har flere aspekter. Der er
intern projektdokumentation, som hovedsageligt består af
kommentarer i deklarationsfiler og kildekodefiler
Intern dokumentation af programmeringsgrænsefladen for projektet, som er lavet ud fra programfilerne af særlige værktøjer, f.eks. Doxygen
ekstern projektdokumentation, som blandt andet består af
ekstern dokumentation af programmeringsgrænseflade, for eksempel for fælles systembiblioteker (KDE, Qt™, etc.)
al øvrig dokumentation (manualer for programmeringssprog, almen systeminformation, vejledninger og lignende)
Al denne dokumentation skal være enkel at vedligeholde og let tilgængelig så snart du behøver den. KDevelop har støtte for netop dette.
forrige | hjem | næste |
Klassehierarki | op | Bygge og projekthåndtering |