How To Write „Good Legacy Code“
Hier sind einige schnelle Ansatzpunkte für das Schreiben von gutem Legacy Code. Code ist viel leichter zu schreiben als zu lesen, und der beste Weg, Probleme zu beheben, ist, sie nicht zu schaffen.
Weniger Code schreiben
Weniger Code = weniger Fehlerpotenzial = weniger zu warten = weniger „schlechte Altlasten“.
Weniger Code zu schreiben, könnte als die wichtigste Methode zur Verbesserung von Code im Allgemeinen angesehen werden. Das DRY-Prinzip kann als natürliche Folge und primäres Mittel angesehen werden, um weniger zu schreiben und mehr zu erreichen.
Vermeiden Sie // TODO und // FIXME
Das Schreiben von // TODO oder // FIXME sollte als rote Fahne und als Codegeruch angesehen werden.
Wenn wir diese Kommentare in ihre eigentliche Bedeutung übersetzen, dann bedeutet „TODO“ „technische Schulden erzeugen“ und „FIXME“ „ich schreibe absichtlich einen Fehler“.
Es mag seltene Ausnahmen geben, in denen das Aufschieben einer Lösung die Vorteile einer sofortigen Lösung überwiegt, aber im Allgemeinen sollten TODO und FIXME auf ein Minimum beschränkt werden.
Bevorzugen Sie etablierte Idiome gegenüber den neuesten Entwicklungen
Das mag widersprüchlich erscheinen… die Verwendung von Spitzentechnologien macht den Code „neuer“, richtig? Nun, ja, aber es schafft auch die Möglichkeit, schneller zu veralten.
Es macht es auch neuen Programmierern schwerer, etwas herauszufinden. Wenn der Code unter Verwendung etablierter Idiome und Frameworks geschrieben wurde, ist er wahrscheinlich leichter zu lesen und hat eine bessere Chance, länger in der Zukunft zu funktionieren.
Verlassen Sie den Code immer in einem besseren Zustand, als Sie ihn vorgefunden haben
Das mag so aussehen, als ob es dem eingangs erwähnten „nicht umschreiben“ widerspricht, aber kontinuierliche Verbesserung und Refactoring ist etwas anderes, als ein umfangreiches Umschreiben.
Versuchen Sie sich anzugewöhnen, Dinge allmählich und schrittweise zu verbessern. Manchmal ist ein großes Refactoring oder eine Neuprogrammierung wirklich notwendig, aber der geschäftliche Nutzen muss sorgfältig gegen andere Prioritäten abgewogen werden.
Verbessern Sie sich ständig als Programmierer
Lesen Sie Bücher, lesen Sie Blogbeiträge, lesen Sie den Code anderer Leute, denken Sie sorgfältig über Design und Programmierpraktiken nach. Denken Sie bewusst über Ihren Code nach und überlegen Sie, wie Sie ihn verbessern können.
Anstatt dem vorherigen Programmierer die Schuld zu geben, ein schlechtes Erbe hinterlassen zu haben, stellen Sie sicher, dass Sie nicht der Programmierer werden, der ein neues schafft.