Unngå feil med gode kommentarer - dummies

Mange avviser kommentarer som en øvelse designet for å kaste bort tid. Men kommentarer er faktisk uvurderlig for å hjelpe deg med å huske hvorfor du gjorde noe på en bestemt måte og for å unngå teknikker som ikke har fungert tidligere. Utover generell dokumentasjon kan kommentarer imidlertid hjelpe deg med å unngå feil.

Følgende er noen av fordelene du får fra gode kommentarer:

• Kommentarer kan dokumentere teknikker som har eller ikke har fungert tidligere.

• Du kan bruke kommentarer som et middel for å fortelle noen formålet med et skript, en funksjon eller en metode - redusere potensialet for å bruke feil kode for et bestemt behov.

• En god kommentar forteller hvorfor noe er gjort på en bestemt måte, noe som bidrar til at kodeendringer ikke introduserer feil.

• Full kommentar betyr dokumentasjon av innganger og utdata, slik at alle vet hvordan de skal samhandle med et skript, en funksjon eller en metode.

• Å vite hvem du skal kontakte om et bestemt problem er en første forsvarslinje mot feil fordi opphavsmannen vanligvis kan fortelle noen hvordan man skal unngå problemer.

• Dokumentere miljøet der koden er designet for å betjene, hjelper deg å forstå når feil skyldes oppdateringer til annen programvare (og ikke selve skriptet, funksjonen eller metoden selv).

Den beste policyen er å unngå feil når du kan. Å unngå en feil er alltid billigere enn å gjenopprette fra en feil. Men den mest kostbare feilen til alle er en som er dødelig og forårsaker at programmet krasjer. Når applikasjoner krasjer, mister folk data og organisasjoner mister kunder. Riktig dokumentasjon hjelper folk å forstå koden bedre og unngå feil før de skjer (eller til og med før noen kan tenke på en måte å gjøre feilen i utgangspunktet).

Den beste kommentaren i verden kan ikke forhindre alle feil. Noen feil skjer bare, og det er ingenting du kan gjøre med dem. For eksempel kan du ikke unngå en feil som oppstår som følge av lynnedslag (datafeil introdusert av elektrisk strøm indusert i en nettverkstilkobling). Noen ganger kan maskinvarefeil og tredjeparts programvare som MATLAB bruker til å utføre oppgaver, også inneholde feil. Mange feilkilder er utenfor din kontroll, men ved hjelp av kommentarer effektivt, kan du redusere antall feil du kan kontrollere.