Indholdsfortegnelse:
Definition - Hvad betyder kommentar?
En kommentar er en speciel konstruktion på et programmeringssprog, der giver programudvikleren mulighed for at nævne yderligere oplysninger, der er knyttet til programmet. Hovedårsagen til at medtage kommentarer i programmeringssprog er at forbedre en kodes portabilitet og vedligeholdelighed.
Techopedia forklarer Kommentar
Ofte arbejder softwareudviklingshold sammen om forskellige softwaremoduler, der inspiceres af testingeniører under testprocessen. Under testprocessen skal ingeniørerne være opmærksomme på, hvordan et modul fungerer. Derfor er kommentarer inkluderet af udvikleren til at forklare arbejdet i et bestemt modul ved at angive de gyldige typer input, antallet af input, algoritmen, der er brugt til behandling i det interne modul, de forventede output og de fejlbetingelser, der kan opstå under behandling.
Kommentarer giver ofte information om forfatteren af indholdet, datoen og tidspunktet for det blev udviklet og den dato og det tidspunkt, hvor det sidst blev ændret. Hvor meget detaljer der skal inkluderes er et spørgsmål om subjektivitet. Nogle udviklere er berygtede for at hader kommentarer og betragter dem som spild af tid. For andre er kommentarer en absolut nødvendighed. I teorien skal en organisation lægge alle sine kodningsstandarder. Uanset hvad som helst grund vil enhver, der har arvet kode fra et tidligere udviklingshold fortælle dig flere gange end ikke, at koden ikke har den kommentar, de gerne ville have set.