Korrektur eines Rechtschreibfehlers in einem Methodennamen

Eine der Methoden, die ich üblicherweise in unserer Codebasis verwende, ist falsch geschrieben (und sie hat mich älter gemacht).

Das irritiert mich wirklich, nicht nur, weil es falsch geschrieben ist, sondern, was noch wichtiger ist, dass ich beim ersten Tippen IMMER den Namen falsch schreibe (und dann muss ich mich daran erinnern, dass "Oh, richtig, es sollte falsch geschrieben sein ...")

Ich ändere ein paar Änderungen an der ursprünglichen Methode. Sollte ich die Gelegenheit nutzen, einfach die Freaking-Methode umzubenennen?

Sollte ich die Gelegenheit nutzen, einfach die Freaking-Methode umzubenennen?

Absolut.

Wenn Ihr Code jedoch als API freigegeben wurde, sollten Sie die falsch geschriebene Methode im Allgemeinen auch belassen und an die korrekt benannte Methode weiterleiten (markieren Sie sie als veraltet, wenn Ihre Sprache solche Dinge unterstützt).

Es gibt Fälle, in denen Sie solche Refactorings vermeiden sollten:

1. Wenn die Methode in einer öffentlichen Schnittstelle verwendet wird. Ein kanonisches Beispiel ist die falsche Schreibweise von Referrern in HTTP- Referrern , wobei die falsche Schreibweise beibehalten wird, da eine Änderung der Schreibweise jetzt zu viele Auswirkungen hätte.

2. Wenn die Codebasis nicht durch Tests abgedeckt ist. Jegliches Refactoring sollte mit getestetem Code durchgeführt werden, um Regressionstests durchführen zu können. Das Refactoring der Codebasis, die nicht getestet wird, ist besonders riskant. Wenn Sie viel Zeit haben, fügen Sie zunächst Tests hinzu. Wenn Sie unter Zeitdruck arbeiten, ist es nicht das Beste, das Risiko einzugehen, dass subtile Fehler auftreten, wenn Sie pünktlich versenden möchten.

3. Wenn die Methode auf ungewöhnliche Weise verwendet werden könnte , ist es praktisch unmöglich, ihre Verwendung zu finden (durch Strg + F oder durch ein automatisiertes Refactoring-Tool). In C # kann beispielsweise eine Methode über Reflection aufgerufen werden, wodurch das Dialogfeld "Umbenennen" von Visual Studio ineffektiv wird. In JavaScript ist die Funktion inside ebenfalls eval()schwer zu finden. In PHP können variable Variablen Probleme verursachen.

4. Wenn die Größe des Projekts sehr groß ist und die Methode von anderen Teams verwendet werden könnte. Dies ähnelt dem ersten Punkt, dh die Schnittstelle, die Sie anderen Teams zur Verfügung stellen, kann als öffentliche Schnittstelle betrachtet werden.

5. Wenn Sie sich mit einem lebenswichtigen Projekt beschäftigen. Es besteht die Möglichkeit, dass die Rechtschreibfehler nicht zu wichtig sind, um ein paar Monate Papierkram zu rechtfertigen, um den Namen der Methode zu ändern und sicherzustellen, dass kein Patient die zehnfache zulässige Bestrahlung erhält, oder dass ein Shuttle die Geschwindigkeit falsch berechnet.

In allen anderen Situationen können Sie die Methode umbenennen.

Ich habe das vor ein paar Monaten gemacht (aus verschiedenen Gründen). Die Schritte, die ich unternahm (die Sprache war Perl):

1. Benennen Sie die Methode um. Verwechseln Sie den alten Namen mit dem neuen Namen (dies sollte keinen Code beschädigen, da die Methode mit beiden Namen aufgerufen werden kann).
2. Informieren Sie den Rest der Entwickler über die Namensänderung und den Grund und fordern Sie sie auf, ab sofort den neuen Namen zu verwenden.
3. Durchsuchen Sie die Codebasis nach dem alten Namen, und beheben Sie alle Vorkommen.
4. Protokollieren Sie alle Verwendungen des alten Namens (die Verwendung des alten Namens sollte zu diesem Zeitpunkt noch funktionieren). Beheben Sie diese Fälle.
5. Warten Sie (während 4.), bis keine Einträge mehr im Protokoll erscheinen.
6. Unterbrechen Sie den Alias. Erstellen Sie eine Methode unter Verwendung des alten Namens, die eine schwerwiegende Ausnahme mit einer Meldung zur Namensänderung auslöst.

7. Entfernen Sie nach einiger Zeit die Methode mit dem alten Namen.

   Natürlich wird Ihr Kilometerstand variieren.

Eine gute Möglichkeit, vorhandenen Code nicht zu beschädigen, ist die Verkettung des neuen Methodennamens mit dem alten in einem solchen wie

private void MyNewMethodName()
{
    TheOldMethodName();
}

und markieren Sie dann die alte Methode als veraltet (wenn Ihre Sprache dies unterstützt). Auf diese Weise funktioniert der vorhandene Code weiterhin und Sie können nach und nach alle alten Rechtschreibfehler aus Ihrer Codebasis entfernen. Eventuell können Sie sogar den Methodentext in die neue Methode kopieren / einfügen und die alte löschen.

/ Bearbeiten Wie ivo im Kommentar sagte: Noch besser wäre es, den Code von TheOldMethodNamein die zu verschieben MyNewMethodNameund die neue Methode von der alten aufzurufen. Dies hätte auch den Vorteil, den Entwicklern zu helfen, sich zu orientieren, wo der Code hingehört.

Methode umbenennen:

• Tun Sie es durch Refactoring, damit Sie mehr Arbeit haben, als Sie wollen
• Wenn Ihre IDE die automatische Vervollständigung unterstützt, verwenden Sie diese, wenn Sie auf diese Methode verweisen

Das sind zwei Optionen, für die Sie sich entscheiden könnten. Ich bevorzuge die automatische Vervollständigung (z. B. Eclipse IDE) und muss den Methodennamen nicht ausgeben. Umbenennung anstreben; Stellen Sie nur sicher, dass Sie herausfinden, wie diese Methode aufgerufen wird, und ändern Sie die direkten Verweise an den einzelnen Stellen. Refactoring wird Ihr Freund dafür sein, aber seien Sie vorsichtig, wenn Sie dies tun.

Ich würde generell ja empfehlen, es umzubenennen.

In anderen Antworten sind gute Gründe aufgeführt, warum Sie die Methode möglicherweise nicht umbenennen möchten. Wenn Sie sich in einer solchen Situation befinden, können Sie eine neue Methode mit dem richtigen Namen und der richtigen Implementierung erstellen und die alte Methode ändern, um die neue Methode aufzurufen . Markieren Sie dann die alte als veraltet, wenn Ihre Sprache dies unterstützt.