Die häufigsten Fehler beim Programmieren - Undurchsichtiger Code
Oben genanntes Problem kann durch einige Faktoren ausgelöst werden und wenn ich mir so manches altes Programm ansehe, dann möchte ich mich mal wieder ohrfeigen. Zum Glück gibt es heutzutage schon einiges Tools, die sowohl beim entwickeln wie auch beim eventuellen späteren aufbereiten eine große Hilfe sein können. Beginnen wir mit Faktoren die für undurchsichtigen Code sorgen.
- Unklare Dateinamen
- Unklare Variablen- und Funktionsbezeichnungen
- Fehlendes einrücken entsprechend der Code Struktur
- Schlechte Verbindungen zwischen verschiedenen Dateien bei Includes oder ähnlichem
Unklare Dateinamen: Damit ist gemeint das Dateinamen immer relativ genau sagen sollten was der Inhalt der Datei tut. Ich selber habe zum Beispiel vor kurzem Dateien gefunden die fkadd1, fkadd2, fkadd3 hießen und ich wusste beim besten Willen nicht was diese tun. Ein Blick in die Dateien verriet mir dann wieder, dass es sich um einzelne Schritte beim hinzufügen von Terminen im Kalender für Freunde handelt. Also F = Friends, K = Kalender und das “add” sollte klar sein. Um so etwas zu umgehen sollte man lieber längere Dateinamen wählen die dafür klarer preisgeben was der Code im inneren tut. Unklare Variablen- und Funktionsbezeichnungen Genau wie bei den Dateinamen sind klare und vor allem sinngemäße Bezeichnungen für Variablen und Funktionen Pflicht um die Übersicht zu behalten. Weiterhin sollte man sich an Konventionen halten die man selber gut findet und somit auch umsetzt. Z.B. sollte man sich entscheiden ob man die Variable “loadfiledescription” so “load_file_description” oder so “loadFileDescription” schreibt und dies dann auch kontinuierlich durchziehen. Das ganze lässt sich auf viele weitere Dinge übertragen und grundsätzlich ist es nur wichtig seinen eigenen Stil zu haben, dem man treu bleibt und den man versteht, solange es nur darauf ankommt das man selber ihn verstehen muss. Arbeitet man gemeinsam an Projekten so kann es natürlich sein das Regeln vorgegeben sind. Ein Tool welches helfen kann ist Eclipse, denn mit der “Rechtsklick / Refactor / Rename” Funktion lassen sich vorkommen von ein und der selben Variable auf einmal umbenennen, dies spart bei nachträglichen Anpassungen einiges an Zeit. Fehlendes einrücken entsprechend der Code Struktur Das Einrücken von Code ermöglicht es wesentlich besser Strukturen zu erkennen und den Code zu verstehen. Ohne die Einrückung kann man z.B. nicht auf Anhieb erkennen wo Schleifen beginnen und enden, selbiges gilt für IF Abfragen oder ähnliches. Auch hier kann Eclipse hilfreich sein denn via “Rechtsklick / Source / Format” wird die gesamte Einrückung automatisch durchgeführt. Dies funktioniert an sich recht gut, allerdings nicht immer ganz so wie man es gerne hätte, mir hilft es trotzdem sehr. Schlechte Verbindungen zwischen verschiedenen Dateien bei Includes oder ähnlichem Arbeitet man mit verschiedenen Dateien so kann es sein das diese sich gegenseitig einbinden. Bei solchen Zugriffen sollte z.B. im Web Coding Bereich darauf geachtet werden das Abfragebezeichnungen zu Dateinamen passen. Also das der Aufruf “http://boehrsi.de/index.php?action=news" auch eine Datei mit dem Namen “news.php” einbindet und nicht eine Datei Namens “blog.php”. Letzteres wäre sinngemäß zwar auch richtig aber würde vielleicht in einigen Situation zu Verwirrung führen. Man sieht das leider sehr viel davon abhängt wie man selber arbeitet und auch Tools nicht immer helfen können. Also am besten von Anfang an versuchen alles strukturiert aufzubauen, denn später ärgert man sich sonst grün und blau.