Video: 10 TIPS FÖR ATT UNDVIKA INBROTT 2024
Många människor avvisar kommentarer som en övning avsedd att slösa tid. Men kommentarer är faktiskt ovärderliga för att hjälpa dig att komma ihåg varför du gjorde något på ett visst sätt och för att undvika tekniker som inte har fungerat tidigare. Utöver allmän dokumentation kan kommentarer dock hjälpa dig att undvika misstag.
Följande är några av de fördelar som du härleder från bra kommentarer:
-
Kommentarer kan dokumentera tekniker som har eller inte har fungerat tidigare.
-
Du kan använda kommentarer som ett sätt att berätta för någon om ett skript, en funktion eller en metod - vilket minskar möjligheten att använda fel kod för ett visst behov.
-
En bra kommentar berättar varför något är gjort på ett visst sätt, vilket hjälper till att säkerställa att kodändringar inte introducerar fel.
-
Fullständig kommentar betyder att du dokumenterar inmatningar och utdata så att alla kan interagera med ett skript, en funktion eller en metod.
-
Att veta vem du ska kontakta om ett visst problem är en första försvarskans mot fel eftersom upphovsmannen vanligtvis kan berätta för någon hur man undviker problem.
-
Dokumentation av miljön i vilken kod är utformad för att fungera hjälper dig att förstå när fel beror på uppdateringar av annan programvara (och inte scriptet, funktionen eller metoden själv).
Den bästa politiken är att undvika fel närhelst du kan. Att undvika ett fel är alltid billigare än att återhämta sig från ett fel. Men det mest kostsamma felet på alla är ett som är dödligt och orsakar att applikationen kraschar. När programmen kraschar, förlorar folk data och organisationer förlorar kunder. Korrekt dokumentation hjälper människor att förstå din kod bättre och undvika misstag innan de händer (eller ens innan någon kan tänka på ett sätt att göra felet i första hand).
Den bästa kommentaren i världen kan inte förhindra alla fel. Några fel händer helt enkelt, och det finns inget du kan göra åt dem. Till exempel kan du inte undvika ett fel som uppstår som ett resultat av en blixtnedslag (datafel som introduceras av elektrisk ström inducerad i en nätverksanslutning). Ibland kan hårddiskar och program från tredje part som MATLAB använder för att utföra uppgifter också kunna innehålla fel. Många felkällor ligger utanför din kontroll, men med hjälp av kommentarer kan du effektivt minska antalet fel som du kan styra.
