Vermeiden von Fehlern mit guten Kommentaren - Dummies

Viele Leute weisen Kommentare als eine Übung zurück, die darauf ausgelegt ist, Zeit zu verschwenden. Aber Kommentare sind von unschätzbarem Wert, wenn es darum geht, sich daran zu erinnern, warum Sie etwas auf eine bestimmte Art und Weise gemacht haben, und um Techniken zu vermeiden, die in der Vergangenheit nicht funktioniert haben. Über die allgemeine Dokumentation hinaus können Kommentare jedoch helfen, Fehler zu vermeiden.

Im Folgenden finden Sie einige der Vorteile, die Sie aus guten Kommentaren ziehen:

• Kommentare können Techniken dokumentieren, die in der Vergangenheit gearbeitet haben oder nicht.

• Sie können Kommentare als Mittel verwenden, um jemandem den Zweck eines Skripts, einer Funktion oder einer Methode mitzuteilen - wodurch die Möglichkeit verringert wird, den falschen Code für einen bestimmten Bedarf zu verwenden.

• Ein guter Kommentar gibt an, warum etwas auf eine bestimmte Art und Weise ausgeführt wird, wodurch sichergestellt wird, dass Codeänderungen keine Fehler verursachen.

• Vollständiges Kommentieren bedeutet, Eingaben und Ausgaben zu dokumentieren, damit jeder weiß, wie man mit einem Skript, einer Funktion oder einer Methode interagiert.

• Zu ​​wissen, an wen man sich bei einem bestimmten Problem wenden kann, ist eine erste Verteidigungslinie gegen Fehler, weil der Urheber in der Regel jemandem sagen kann, wie er Probleme vermeiden kann.

• Das Dokumentieren der Umgebung, in der der Code ausgeführt werden soll, hilft Ihnen zu verstehen, wann Fehler durch Aktualisierungen anderer Software (und nicht des Skripts, der Funktion oder der Methode selbst) verursacht werden.

Die beste Vorgehensweise besteht darin, Fehler zu vermeiden, wann immer Sie können. Die Vermeidung eines Fehlers ist immer kostengünstiger als die Wiederherstellung nach einem Fehler. Der kostspieligste aller Fehler ist jedoch einer, der schwerwiegend ist und zum Absturz der Anwendung führt. Wenn Anwendungen abstürzen, verlieren Benutzer Daten und Organisationen verlieren Kunden. Eine korrekte Dokumentation hilft den Leuten, Ihren Code besser zu verstehen und Fehler zu vermeiden, bevor sie auftreten (oder sogar bevor jemand sich eine Möglichkeit ausdenken kann, den Fehler von vornherein zu machen).

Der beste Kommentar der Welt kann nicht alle Fehler verhindern. Einige Fehler passieren einfach und Sie können nichts dagegen tun. Beispielsweise können Sie einen Fehler nicht vermeiden, der als Ergebnis eines Blitzschlags auftritt (Datenfehler, die durch in eine Netzwerkverbindung induzierten elektrischen Strom verursacht werden). Manchmal können auch Hardwarefehler und Software von Drittanbietern, die MATLAB verwendet, um Aufgaben auszuführen, Fehler enthalten. Viele Fehlerquellen liegen außerhalb Ihrer Kontrolle, aber durch die effiziente Verwendung von Kommentaren können Sie die Anzahl der Fehler reduzieren, die Sie steuern können.