Vermeidung von Fehlern mit Gut Kommentare
Eine Menge Leute entlassen Kommentare als Übung zu verschwenden Zeit entworfen. Aber Kommentare sind wirklich von unschätzbarem Wert bei der Sie sich zu erinnern, warum Sie etwas in einer bestimmten Art und Weise tat und Techniken zu vermeiden, die nicht in der Vergangenheit zusammengearbeitet. Neben allgemeinen Dokumentation kann jedoch Kommentare Sie Fehler vermeiden helfen.
Im Folgenden sind einige der Vorteile, die Sie von der guten Kommentare ableiten:
Kommentare können Techniken dokumentieren, die haben oder nicht in der Vergangenheit zusammengearbeitet.
Sie können sagen, jemand, den Zweck eines Skripts, Funktion oder Methode Kommentare als Mittel nutzen - das Potenzial, die Verringerung der falschen Codes für einen besonderen Bedarf für die Verwendung.
Ein guter Kommentar sagt, warum etwas in einer bestimmten Art und Weise durchgeführt wird, die sich aus dieser Codeänderungen einführen keine Fehler hilft sicherzustellen.
Vollständige Kommentierung Mittel dokumentieren Ein- und Ausgänge, so dass jeder weiß, wie man mit einem Skript, eine Funktion oder Methode zu interagieren.
Zu wissen, wem über ein bestimmtes Thema zu kontaktieren ist eine erste Verteidigungslinie gegen Fehler, weil der Urheber in der Regel jemand, wie Probleme zu vermeiden, sagen kann.
ist die Umgebung, Dokumentieren, in dem Code für einen Betrieb hilft Ihnen zu verstehen, wenn Fehler durch Aktualisierungen anderer Software (und nicht das Skript, eine Funktion oder Methode selbst) verursacht werden.
Die beste Politik ist es, Fehler zu vermeiden, wann immer Sie können. einen Fehler zu vermeiden, ist immer weniger kostspielig als von einem Fehler erholt. Allerdings ist der teuerste Fehler aller ein, die tödlich ist und bewirkt, dass die Anwendung zum Absturz bringen. Wenn Anwendungen Absturz, verlieren die Menschen verlieren Daten und Organisationen Kunden. Eine entsprechende Dokumentation hilft den Menschen, den Code besser zu verstehen und Fehler zu vermeiden, bevor sie auftreten (oder sogar, bevor jemand einen Weg finden kann, den Fehler in erster Linie zu machen).
Der beste Kommentar in der Welt können alle Fehler nicht verhindern. Einige Fehler einfach passieren, und es gibt nichts, was man dagegen tun kann. Zum Beispiel können Sie nicht einen Fehler zu vermeiden, die als Folge eines Blitzeinschlages (induziert in eine Netzwerkverbindung von Datenfehlern eingeführt durch elektrischen Strom) auftritt. Manchmal Hardware Pannen und Software von Drittanbietern, die MATLAB verwendet Aufgaben Fehler enthalten kann, auch. Viele Fehlerquellen sind außerhalb Ihrer Kontrolle, aber unter Verwendung von Kommentaren effektiv hilft Ihnen, die Anzahl der Fehler zu reduzieren, die Sie steuern können.