Video: Help fouten voorkomen – Willy Govaarts 2024
Veel mensen negeren opmerkingen als een oefening die is ontworpen om tijd te verspillen. Maar opmerkingen zijn van onschatbare waarde om u te helpen herinneren waarom u iets op een bepaalde manier hebt gedaan en om technieken te vermijden die in het verleden niet hebben gewerkt. Naast algemene documentatie kunnen opmerkingen u echter helpen fouten te voorkomen.
Hieronder volgen enkele van de voordelen die u aan goede opmerkingen kunt ontlenen:
-
Opmerkingen kunnen technieken documenteren die in het verleden al dan niet hebben gewerkt.
-
U kunt opmerkingen gebruiken om iemand het doel van een script, functie of methode te laten weten - waardoor het potentieel voor het gebruik van de verkeerde code voor een specifieke behoefte wordt verkleind.
-
Een goede opmerking vertelt waarom iets op een bepaalde manier wordt gedaan, wat ervoor zorgt dat codewijzigingen geen fouten introduceren.
-
Volledige commentaar houdt in dat invoer en uitvoer worden gedocumenteerd zodat iedereen weet hoe een script, functie of methode moet worden gebruikt.
-
Weten met wie contact moet worden opgenomen over een bepaald onderwerp is een eerste verdedigingslinie tegen fouten, omdat de opsteller meestal iemand kan vertellen hoe hij problemen kan voorkomen.
-
Het documenteren van de omgeving waarin de code is ontworpen om te werken, helpt u te begrijpen wanneer fouten worden veroorzaakt door updates van andere software (en niet door het script, de functie of de methode zelf).
Het beste beleid is om fouten te voorkomen wanneer u maar kunt. Het vermijden van een fout is altijd minder duur dan het herstellen van een fout. De meest kostbare fout van allemaal is echter een die fataal is en ervoor zorgt dat de toepassing crasht. Wanneer applicaties crashen, raken mensen gegevens kwijt en raken organisaties klanten kwijt. Goede documentatie helpt mensen uw code beter te begrijpen en fouten te voorkomen voordat ze zich voordoen (of zelfs voordat iemand een manier bedacht kan hebben om de fout te maken).
De beste opmerking ter wereld kan niet alle fouten voorkomen. Sommige fouten gebeuren gewoon en er is niets dat u eraan kunt doen. U kunt bijvoorbeeld niet voorkomen dat een fout optreedt als gevolg van een blikseminslag (datafouten geïntroduceerd door elektrische stroom geïnduceerd in een netwerkverbinding). Soms kunnen hardwareglekken en software van derden die MATLAB gebruikt om taken uit te voeren, ook fouten bevatten. Veel foutenbronnen staan buiten uw macht, maar het effectief gebruiken van opmerkingen helpt u om het aantal fouten dat u kunt beheren te verminderen.
