• Forside
• Dokumentation
• GDPR for udviklere
• 10. God kode og …

10. God kode og dokumentation

Det er vigtigt at anvende gode kodningsmetoder så tidligt som muligt. Læselig kode reducerer vedligeholdelsesindsatsen og gør det lettere at rette fejl over tid for dig og dine (mulige fremtidige) samarbejdspartnere.

Dokumentér kode og arkitektur

• Dokumentation bliver nogle gange nedprioriteret under udvikling på grund af tidsmangel eller manglende overblik over projektet. Dog er det afgørende for vedligeholdelsen af dit projekt: det giver et samlet billede af, hvordan koden fungerer, og gør det lettere at forstå, hvilke dele der påvirkes af ændringer.

• Dokumentér arkitekturen, ikke kun koden: For at bevare overblikket skal din dokumentation også forklare, hvordan alle komponenter arbejder sammen. Brug derfor diagrammer og klare forklaringer.

• Vedligehold dokumentationen sammen med koden: Den bedste måde at holde dokumentationen opdateret på er at ændre den løbende i takt med kodeændringer.

• Hvis du bruger en kildekodehåndtering, kan du inkludere dokumentationsændringer i hver “commit”, der ændrer din kode (se også ark nr. 4: Håndter din kildekode).

• Glem ikke at adressere sikkerhed i din dokumentation. Dokumentér de forskellige konfigurationsvalg i din applikation, og forklar hvilke indstillinger der er mest sikre.

Tjek kvaliteten af din kode og dens dokumentation

• Kode af høj kvalitet indebærer anvendelse af best practices og kodningskonventioner, som konsekvent følges i hele programmet. Det anbefales også at følge eksisterende konventioner. Her er nogle eksempler på gode praksisser:

  • Brug eksplicitte variabel- og funktionsnavne, så det er nemt at forstå, hvad koden gør ved første øjekast.
  • Indenter koden korrekt, så strukturen bliver let at aflæse.
  • Undgå redundant kode, da det reducerer indsatsen ved fejlrettelser og mindsker risikoen for at overse noget.

• Værktøjer kan hjælpe dig med at kontrollere kodekvaliteten. Når de er korrekt konfigureret, kan de spare tid ved automatisk at sikre overholdelse af kodningsstandarder. Eksempler på disse værktøjer inkluderer:

  • Integrerede udviklingsmiljøer (IDE’er), eventuelt med plugins, kan konfigureres til at håndhæve regler for kodeindrykning, linjeskift mellem kodeblokke, placering af klammeparenteser osv.
  • Software til måling af kildekodekvalitet kan identificere kode-duplikeringer, overholdelse af programmeringsregler og potentielle fejl.