Wie kann man gegen die Senkung der Qualitätsstandards für ältere Codebasen argumentieren? [geschlossen]

Wir haben hier eine große alte Codebasis mit schlechtem Code, den Sie sich nicht vorstellen können.

Wir haben jetzt einige Qualitätsstandards definiert und möchten diese entweder in einer komplett neuen Codebasis erfüllen, aber auch, wenn Sie den alten Code berühren.

Und wir erzwingen diese mit Sonar (Code-Analyse-Tool), das bereits einige Tausend Verstöße aufweist.

Jetzt kam die Diskussion auf, um diese Verstöße für das Erbe zu verringern. Weil es Vermächtnis ist.

In der Diskussion geht es um Lesbarkeitsregeln. Wie viele verschachtelte ifs / for .. kann es haben.

Wie kann ich nun dagegen argumentieren, dass unsere Codierungsqualität bei Legacy-Code abnimmt?

Code ist nur ein Mittel zum Zweck. Was das Ziel sein mag, ist unterschiedlich, aber in der Regel ist es Gewinn.

Wenn es Profit ist; um dann erfolgreich zu argumentieren, dass alles, was Sie zeigen möchten, den Gewinn verbessert - z. B. durch Steigerung des Umsatzes, Reduzierung der Wartungskosten, Reduzierung der Entwicklungskosten, Senkung der Löhne, Reduzierung der Umschulungskosten usw. den Gewinn verbessern; dann sagst du meistens nur, es wäre eine lustige Art, Geld in die Toilette zu spülen.

Ich selbst und ich waren sowohl Produzent als auch Erhalter von Legacy-Code. Wenn Ihr Tool "Tausende von Verstößen" (oder sogar Hunderte von Verstößen) verursacht, vergessen Sie das Tool, es ist auf die Situation nicht anwendbar ...

Ich gehe davon aus, dass die ursprünglichen Entwickler schon lange nicht mehr zur Diskussion stehen. Es ist also niemand da, der das Warum und Warum des Design- und Codierungsstils versteht. Das Korrigieren von Hunderten oder Tausenden von Verstößen bedeutet nicht, hier und da ein paar Codezeilen neu zu schreiben. Stattdessen ist zweifellos eine Umgestaltung / funktionale Zersetzung erforderlich. Sie versuchen, dies mit einer großen vorhandenen Codebasis zu tun, ohne deren aktuelles Design genau zu verstehen, und Sie sind verpflichtet, eine ganze Reihe neuer Bugs / Probleme / etc. Einzuführen. Nur eine neue Dose Würmer, die noch schlimmer ist als die, die Sie jetzt haben (oder schlimmer als Ihr Werkzeug, das Sie jetzt >> denken <<).

Der einzig vernünftige Ansatz, um "Tausenden von Verstößen" entgegenzutreten, wäre das Neuschreiben von Grund auf. Ein langer und teurer Aufwand, der kaum an das Management zu verkaufen ist. Und in diesem Fall haben sie wahrscheinlich recht ...

Legacy-Code erfordert in der Regel nur Optimierungen. Zum Beispiel für das Jahr 2000 oder wenn die Aktien von 256 auf Dezimal gestiegen sind. Ich habe jede Menge Cr * P gemacht. Und viele andere ähnliche Sachen. Es ist in der Regel ziemlich "genau", dass Sie den manchmal schlechten Stil, die schlechte funktionale Zerlegung, das schlechte usw. "durchlesen" und die Sammlung von Stellen finden können, die geändert werden müssen. Und dann kann es Ihnen ein Rätsel bleiben, was "zwischen diesen Orten" passiert, dh was ist der Fluss auf höherer Ebene? Stellen Sie einfach sicher, dass Sie die lokalisierte Funktionalität verstehen, die Sie ändern, und testen Sie, testen Sie, testen Sie auf Nebenwirkungen usw., die von Ihrem lokalisierten Wissen nicht vorhergesehen werden können.

Wenn Sie sich so nicht durch Code zurechtfinden, sind Sie möglicherweise nicht die beste Person, um älteren Code zu verwalten. Einige Leute können mit einem leeren Bildschirm beginnen und schöne Programme schreiben, aber nicht mit einer großen Codebasis des Codes anderer Leute beginnen und ihn pflegen. Andere Leute können Code pflegen, aber nicht von vorne anfangen. Manche können beides. Stellen Sie sicher, dass die richtigen Personen Ihren Legacy-Code verwalten.

Es kann vorkommen, dass Sie Ihre alte Codebasis von Grund auf neu entwerfen und umschreiben möchten, wenn sich die geschäftlichen (oder sonstigen) Anforderungen so stark ändern, dass "Tweaks" am Hosenplatz den geänderten Anforderungen einfach nicht mehr gerecht werden . Zu diesem Zeitpunkt können Sie auch gleich ein neues Dokument mit den funktionalen Anforderungen verfassen und sicherstellen, dass alle Beteiligten an Bord sind. Es ist im Grunde ein ganz neues Ballspiel.

Die einzige >> falsche << Sache, die Sie tun müssen, ist, die Pflege von Legacy-Code so zu behandeln, wie Sie es bei der Neuentwicklung tun würden. Und dieses eine falsche Ding scheint genau der Weg zu sein, den Sie einschlagen möchten :) Nehmen Sie mein Wort dafür, das ist nicht das, was Sie tun wollen.

Die Frage ist nicht, wie gut oder schlecht dieser Code ist. Die Frage ist, wie viel Nutzen Sie aus wie viel Investition ziehen.

Sie haben also ein Tool, das Tausende von Dingen findet, die es nicht mag. Sie haben die Wahl, die Ergebnisse des Tools zu ignorieren oder Arbeit zu investieren, um Tausende von Dingen zu ändern. Das ist eine Menge Zeug. Die Leute werden nicht fokussiert, nicht während sie die Änderungen vornehmen, nicht während sie sie überprüfen, und dies wird nicht richtig getestet, da es Ewigkeiten dauert, um herauszufinden, wie man jede Änderung testet (oder nur ausprobiert), so dass es Fehler gibt. Also, bis Sie diese Fehler gefunden und behoben haben, haben Sie viel Zeit und Geld mit einem insgesamt negativen Ergebnis investiert.

Andererseits können Tools Dinge finden, die sie nicht nur "nicht mögen", sondern die Fehler oder potenzielle Fehler sind. Wenn der Legacy-Code noch weit verbreitet ist, kann das richtige Tool tatsächlich Fehler finden. Daher kann es sich lohnen, die Compiler-Warnungen einzeln zu aktivieren, zu überprüfen, ob sie nützlich sind (nicht alle sind nützlich), und diese Warnungen zu beheben.

Wenn es nicht kaputt ist, beheben Sie es nicht

Dies sollte praktisch auf jeden Softwareentwickler und -manager tätowiert werden, damit er es nie vergisst.

Ja, es verstößt gegen alle modernen Kodierungskonventionen. Ja, es ist in FORTRAN-77 mit einem Wrapper in C geschrieben, damit es von Python aus aufgerufen werden kann. Ja, das sind unstrukturierte GOTOs. Ja, es gibt ein Unterprogramm mit dreitausend Zeilen. Ja, die Variablennamen sind nur für einen Kroaten sinnvoll. usw. usw.

Aber wenn es über ein Jahrzehnt oder länger im Zorn getestet wurde und vergangen ist, lass es in Ruhe! Wenn die erforderliche Änderung gering ist, halten Sie sie so klein und lokal wie möglich. Alles andere birgt das größere Risiko, etwas zu beschädigen, das nicht repariert werden musste.

Natürlich stellt man manchmal fest, dass es sich wirklich um eine nicht zu wartende Kluge handelt und dass die einzige Möglichkeit, die "kleine" Modifikation zu berücksichtigen, darin besteht, sie von Grund auf neu zu schreiben. In diesem Fall müssen Sie zu demjenigen zurückkehren, der nach der Änderung fragt, und ihm mitteilen, was sie kosten wird (sowohl in Dollar oder Mannstunden für das Umschreiben als auch in Blutschweiß und Tränen für die unvermeidlichen neuen Fehler).

Vor langer Zeit gab es eine Reihe von Ausfällen bei einem der Festplattenlaufwerke von Digital. Am Ende haben sie sich alle bei gord zurückgerufen und ersetzt, was es gekostet hat. Anscheinend befand sich in der HDA ein Klebestreifen mit einem Filter. Das Konstruktionsmanifest sagte über den Klebstoff "Nicht parametrisch spezifiziert, KEINE ERSATZSTOFFE AKZEPTIERBAR". Ein Bohnenzähler "sparte" weniger als einen Cent pro Laufwerk, indem er einen anderen Klebstoff beschaffte. Es gab einen Dampf im HDA ab, der die Festplatte nach ein paar Betriebsjahren tötete. Es war nicht kaputt, bis er es reparierte. Zweifellos "es war nur eine winzige Veränderung ..."

Es ist definitiv nicht sinnvoll, die Qualitätsstufe für Legacy-Code zu verringern. Es ist auch nicht erforderlich, Warnungen sofort zu beheben. Stellen Sie einfach sicher, dass alle Ihre "neuen" Änderungen in jeder Komponente Ihres Projekts einem hohen Qualitätsstandard entsprechen. Dh kein Commit sollte die Anzahl der Warnungen jemals erhöhen.

Es ist ein einheitlicher und absolut einfacher Ansatz.

Es lässt zu, dass alter Legacy-Code unverändert funktioniert (da keine unnötigen Änderungen daran vorgenommen werden). Es stellt sicher, dass neuer Code von hoher Qualität ist. Es fallen keine zusätzlichen Kosten an.

Risikokontrolle….

• Der Code in der großen Legacy-Codebasis wurde zumindest unter Verwendung der Software im realen Leben getestet.
• Es ist sehr unwahrscheinlich, dass der Code in der großen alten Codebasis durch automatisierte Komponententests abgedeckt wird.
• Daher ist jede Änderung der Erkältung in der großen alten Codebasis ein hohes Risiko.

Kosten….

• Es ist billig, den Code während des Schreibens einer Codeüberprüfung zu unterziehen
• Dies zu einem späteren Zeitpunkt zu tun, ist sehr viel kostspieliger

Vorteil

• Sie hoffen, dass die Einhaltung von Codierungsstandards zu einem besseren Code-Design führt.

• Es ist jedoch sehr unwahrscheinlich, dass eine Person, die viele Wochen lang den Code ändert, um Warnungen aus einem Tool zur Überprüfung des Codestandards zu entfernen, das Design des Codes verbessert.

• Einfacher Code ist klarer und in der Regel einfacher zu verstehen, es sei denn, der komplexe Code wird von jemandem, der ihn nicht versteht, in kurze Methoden aufgeteilt.

Empfehlung….

• Wenn in einem Codeabschnitt viele Fehler auftreten oder viele Änderungen zum Hinzufügen zusätzlicher Funktionen erforderlich sind, müssen Sie die Funktionsweise zu 100% verstehen.
• Verbringen Sie auch die Zeit damit, diesem Codeabschnitt einen guten Komponententest hinzuzufügen, da Sie nachweislich einen Bedarf dafür haben.
• Sie könnten dann erwägen, den Code neu zu gestalten (wie Sie jetzt wissen), damit er auch die neue Codeprüfung besteht.

Persönlich erleben….

• In den letzten 20 Jahren meiner Tätigkeit als Programmierer habe ich noch nie einen Fall erlebt, in dem die blinde Änderung der alten, um die gesamte Ausgabe eines neuen Codierungsstandardprüfers zu entfernen, neben der Erhöhung des Einkommens der beauftragten Auftragnehmer auch Vorteile hatte.
• Ebenso, wenn alter Code erstellt werden muss, um Codeüberprüfungen zu bestehen (TickIt / ISO 9001 falsch durchgeführt), bei denen der alte Code wie der neue Codierungsstandard aussehen musste.
• Ich habe viele Fälle erlebt, in denen die Verwendung von Standard-Überprüfungswerkzeugen für neuen Code durch die Reduzierung der laufenden Kosten große Vorteile gebracht hat.
• Ich habe noch nie erlebt, dass ein Unternehmen die Kosten für die Wartung von altem Code, der in einem Produkt mit vielen Kunden verwendet wird, nicht bezahlt hat.
• Ich habe gesehen, dass das Unternehmen scheitert, weil es das Einkommen der Kunden nicht dadurch erzielt, dass es zu langsam auf dem Markt ist.

Ist die Diskussion über die Senkung der Schwellenwerte des Werkzeugs? ... oder habe ich es falsch verstanden. Es ist verwirrend geschrieben. Wenn nicht, verwerfen Sie bitte meine Antwort.

IMHO wäre es eine gute Idee, die Empfindlichkeit des Werkzeugs zu reduzieren. Warum? Weil es die haarigsten Teile des Codes hervorheben würde. Die Alternative besteht darin, Berichte mit Tausenden von Verstößen zu erstellen, die aufgrund ihrer Größe unbrauchbar werden.

... ansonsten sprechen Sie einfach mit den Beteiligten darüber und erfahren Sie auch deren Gründe.

Ich würde versuchen, den alten Code vom neuen sauberen Code zu trennen. In zB Eclipse können Sie dies tun, indem Sie sie in verschiedene Projekte einfügen, die sich gegenseitig verwenden. 'Clean'-Projekt und ' Legacy'-Projekt .

Auf diese Weise können Sie beide Projekte in Sonar mit unterschiedlichen Qualitätsstandards analysieren. Die Standards sollten sich nur in der Wichtigkeit der Regeln unterscheiden. Die Regeln selbst sollten gleich sein. Auf diese Weise können Sie im "Legacy" -Projekt sehen, was "repariert " werden muss, um die Standards des "Clean" -Projekts zu erfüllen .

Wann immer Sie es geschafft haben, einen alten Code auf die höheren Standards zu heben, können Sie ihn in das 'Clean'-Projekt verschieben.

In der täglichen Arbeit kann man es aufgrund der zeitlichen Verzögerung nicht schaffen, jede Klasse, die man berührt, an die „sauberen“ Projektstandards heranzuführen. Sie sollten jedoch versuchen, in kleinen Schritten dorthin zu gelangen, indem Sie versuchen, den Legacy-Code bei jeder Berührung ein wenig zu verbessern.