God dokumentation af ens kode.

synes jeg manglet at skrive

jeg prøver at holde mine kommentar i "afsnit" f.eks alle kommentar til en funktion vil være i toppen af funktionen ikke spredt ud med små kommentar her og der. da jeg prøver at holde koden så simple og læslig som muligt at det ikke burde være nødvendigt med kommentar til at forklare hvordan tingene bliver gjort.

og glemte også at skrive at variabler jeg synes har brug for forklaring bliver også kommenteret.

kigger med.

Det lyder som om din "kode dokumentation" er ganske glimrende.

Jeg vil sige: langt over gennemsnittet.

Men "kode dokumentation" har meget svært ved at stå alene. Det bør suppleres med
noget "applikations dokumentation".

En overordnet beskrivelse af:
  - lag
  - flow
  - design principper

Hvis du er til den slags så: UML klasse og sekvens diagrammer.

Den form for dokumentation er uhyre vigtig. Det er nemlig meget svært at læse
100000 linier kode med beskrivelse af funktioner og så danne sig et indtryk af den
samlede applikation.

Det er langt nemmere at læse en høj niveau beskrivelse af applikationen, finde ud af
hvad det er man skal kigge på og så studere den mere detaljerede dokumentation for
den del.

ja det giver jo rigtig god mening, det er mange gange det jeg selv har stået og manglet når man skal overtage et system.

kender du et godt eksempel på et godt dokumenteret system, som jeg evt kunne få et indtryk af hvordan man skriver sådan en applikation dokumentation.

Jeg kan ikke lige umiddelbart komme i tanke om et eksempel på en sådan dokumentation
som er offentlig tilgængelig.

så det vist tid til at lukke her, ser ikke ud til der er yderligere tilføjelser, mange tak for hjælpen arne! vil søge lidt videre på det.

( smid et svar :) )

svar