Undgå fejl med gode kommentarer - dummier

Mange afviser kommentarer som en øvelse designet til at spilde tid. Men kommentarer er faktisk uvurderlige for at hjælpe dig med at huske, hvorfor du gjorde noget på en bestemt måde og for at undgå teknikker, der ikke har fungeret tidligere. Udover generel dokumentation kan kommentarer dog hjælpe dig med at undgå fejl.

Følgende er nogle af de fordele, du får af gode kommentarer:

• Kommentarer kan dokumentere teknikker, der har eller ikke har fungeret tidligere.

• Du kan bruge kommentarer som et middel til at fortælle nogen formålet med et script, en funktion eller en metode - reducere muligheden for at bruge den forkerte kode til et bestemt behov.

• En god kommentar fortæller hvorfor noget er gjort på en bestemt måde, hvilket hjælper med til at sikre, at kodeændringer ikke introducerer fejl.

• Fuld kommentar betyder at dokumentere input og output, så alle kan vide, hvordan man interagerer med et script, en funktion eller en metode.

• At vide, hvem der skal kontaktes om et bestemt problem er en første forsvarslinje mod fejl, fordi ophavsmanden normalt kan fortælle nogen hvordan man kan undgå problemer.

• Dokumentation af miljøet, hvor koden er designet til at fungere, hjælper dig med at forstå, hvornår fejl skyldes opdateringer til anden software (og ikke script, funktion eller metode selv).

Den bedste politik er at undgå fejl, når du kan. Undgå en fejl er altid billigere end at gendanne sig fra en fejl. Men den mest kostbare fejl på alle er en, der er dødelig og får applikationen til at gå ned. Når applikationer går i stykker, mister folk data og organisationer mister kunder. Korrekt dokumentation hjælper folk med at forstå din kode bedre og undgå fejl, før de sker (eller endda før nogen kan tænke på en måde at gøre fejlen i første omgang).

Den bedste kommentar i verden kan ikke forhindre alle fejl. Nogle fejl sker simpelthen, og der er ikke noget, du kan gøre ved dem. For eksempel kan du ikke undgå en fejl, der opstår som følge af lynnedslag (datafejl indført af elektrisk strøm induseret til en netværksforbindelse). Nogle gange kan hardwarefejl og tredjeparts software, som MATLAB bruger til at udføre opgaver, også indeholde fejl. Mange fejlkilder er uden for din kontrol, men ved hjælp af kommentarer effektivt kan du reducere antallet af fejl, du kan styre.