Dokumentation

så vidt jeg ved, er det at dokumentere det *normalt* at indsætte kommentarer i scriptet, så at det er nemt at finde ud af hvad de enkelte linier med kode er.

Bare skriv en ' foran dine kommentarer¨.

Jeg har indsat en masse kommentarer i koden, men ifølge mine lærer er det ikke nok.

http://www.msdn.microsoft.com/library/default.asp?url=/nhp/default.asp?contentid=28000520
Det må være det eller?

Af ren nysggerighed vil jeg gerne høre hvilken skole eller hvad du er ved at uddanne dig som?

/casper - http://ildstorm.dk

it og elektronikteknolog på Århus tekniske skole

Dokumentation er blot en beskrivelse af dit projekt/program.

-Hvad kan programmet
-Hvordan virker det
-Hvilke metoder er anvendt

osv osv

Øh, det link som du har lagt ved, hvad var det lige som jeg kunne bruge der, det kan godt være at jeg har overset det ??

når jeg har skulle dokumentere noget, har jeg tegnet et flowdiagram, der viser hvordan de data programmet fodres med bliver smidt rundt mellem procedurer.. Altså sådan noget med nogle kasser med nogle pile imellem. Desuden har jeg lavet test-input med kendt output, som gerne skulle teste de forskellige typer af beregninger programmet foretager. Og så skulle output jo gerne være rigtigt ;o)

Men da jeg ikke ved hvad dit program gør, er det svært at sige. Måske beregner det slet ikke noget - måske håndterer det bare en database eller?

Men hvorfor spørger du dog ikke din lære hvad han vil have - det er da det mest naturlige...

tsearex >> Ok troede du ville have dokumation på de forskellige funktioner, metoder m.m. overså det.

Manual nået vel?

Jeg har snakket med min lærer, og han har faktisk også snakket om flowdiagrammer. Men jeg tror faktisk ikke, at han har prøvet at dokumenterer software selv, så jeg blev ikke meget klogere. Vi har i det hele taget ikke meget programmering på uddannelsen.

Mit program sender og modtager data ved hjælp af seriel porten.

Som udgangspunkt skal din dokumentation altid kunne sætte dig og især andre ind i tankegangen bag dit projekt...dvs beskriv hvilken problemstilling dit projekt skal kunne løse og beskriv i detaljer hvilke overvejelser du har gjort dig i denne forb. og forklar funktionen af den løsningsmodel som du er nået frem til.

Forklar, gerne med illustrationer og blokdiagrammer, hvordan du har lavet din protokol, hvordan dit program behandler den data som der modtages og hvordan den tilsluttede hardware reagere på input fra din software.

På større funktioner/subs i din software, laver du såkaldte modulbeskrivelser, der fortæller om sub´ens funktion, samt om de variabler som den modtager og/eller behandler.
Husk hele tiden at argumentere for dine valg, og beskriv også gerne de bugs du har oplevet/løst.

Forsøg at forklarer tingene som var det til en ikke teknisk begavet person...overdrivelse fremmer forståelsen.

God fornøjelse og held og lykke til eksamen =:-)

Hvis du har lavet det objekt-orienteret, ville et klassediagram ikke være helt af vejen  :-)