Naprawianie błędu pisowni w nazwie metody

Jedną z metod, których zwykle używam w naszej bazie kodu, jest niepoprawna (i poprzedza mnie).

To naprawdę irytuje mnie nie tylko dlatego, że jest źle napisane, ale, co ważniejsze, sprawia, że ​​ZAWSZE mylę nazwę przy pierwszym wpisywaniu (a potem muszę pamiętać: „Och, racja, należy ją źle odczytać ...”)

Wprowadzam kilka zmian w stosunku do oryginalnej metody. Czy powinienem skorzystać z okazji, aby po prostu zmienić nazwę tej dziwacznej metody?

Czy powinienem skorzystać z okazji, aby po prostu zmienić nazwę tej dziwacznej metody?

Absolutnie.

To powiedziawszy, jeśli twój kod został wydany jako API, powinieneś również ogólnie zostawić niepoprawną metodę i przekazać ją do poprawnie nazwanej metody (oznaczenie jako Nieaktualne, jeśli Twój język obsługuje takie rzeczy).

Są przypadki, w których należy unikać takich refaktoryzacji:

1. Jeśli metoda jest używana w interfejsie publicznym. Kanonicznym przykładem jest błędna pisownia strony odsyłającej w odsyłaczu HTTP , przy zachowaniu niepoprawnej pisowni, ponieważ zmiana pisowni miałaby teraz zbyt wiele następstw.

2. Jeśli podstawa kodu nie jest objęta żadnymi testami. Wszelkie refaktoryzacje należy przeprowadzać na testowanym kodzie, aby móc przeprowadzić test regresji. Refaktoryzacja bazy kodu, która nie jest testowana, jest szczególnie ryzykowna. Jeśli masz dużo czasu, zacznij od dodania testów; jeśli pracujesz pod presją czasu, podejmowanie ryzyka wprowadzenia subtelnych błędów nie jest najlepszym rozwiązaniem, jeśli chcesz wysłać na czas.

3. Jeśli metoda może być użyta w nietypowy sposób , co praktycznie uniemożliwia jej zastosowanie (za pomocą Ctrl + F lub zautomatyzowanego narzędzia do refaktoryzacji). Na przykład w języku C # można wywołać metodę poprzez odbicie, co powoduje, że okno dialogowe Zmień nazwę programu Visual Studio jest nieskuteczne. W JavaScript eval()trudno jest również znaleźć funkcję o nazwie inside . W PHP zmienne zmienne mogą powodować problemy.

4. Jeśli wielkość projektu jest ogromna, a metoda może zostać wykorzystana przez inne zespoły. Jest to podobne do pierwszego punktu, tzn. Interfejs, który udostępniasz innym zespołom, można uznać za interfejs publiczny.

5. Jeśli masz do czynienia z projektem krytycznym dla życia. Możliwe, że błąd ortograficzny nie jest zbyt ważny, aby uzasadnić kilka miesięcy papierkowej roboty w celu zmiany nazwy metody i upewnienia się, że nie spowoduje to, że żaden pacjent otrzyma dziesięciokrotność autoryzowanego promieniowania lub jakiegokolwiek wahadłowca, aby przeliczyć prędkość.

W każdej innej sytuacji możesz zmienić nazwę metody.

Zrobiłem to kilka miesięcy temu (z różnych powodów). Kroki, które podjąłem (językiem był Perl):

1. Zmień nazwę metody. Alias ​​od starej nazwy do nowej nazwy (nie powinno to łamać żadnego kodu, ponieważ metodę można wywołać dowolną nazwą).
2. Poinformuj pozostałych programistów o zmianie nazwy i dlaczego, mówiąc im, aby odtąd używali nowej nazwy.
3. Grep bazę kodu dla starej nazwy, napraw wszelkie wystąpienia.
4. Zaloguj wszelkie zastosowania starej nazwy (używanie starej nazwy powinno w tej chwili nadal działać). Napraw te przypadki.
5. Poczekaj (wykonując 4.), aż w dzienniku nie będzie już więcej wpisów.
6. Przełam alias. Utwórz metodę, używając starej nazwy, która zgłasza krytyczny wyjątek z komunikatem o zmianie nazwy.

7. Po pewnym czasie usuń metodę o starej nazwie.

   Oczywiście twój przebieg będzie się różnić.

Dobrym sposobem na nie zerwanie żadnego istniejącego kodu byłoby połączenie nowej nazwy metody ze starą w takiej jak

private void MyNewMethodName()
{
    TheOldMethodName();
}

a następnie oznacz starą metodę jako przestarzałą (jeśli Twój język to obsługuje). W ten sposób każdy istniejący kod będzie nadal działał i będziesz mógł stopniowo usuwać wszystkie stare błędy pisowni ze swojej bazy kodu. W końcu możesz nawet skopiować / wkleić treść metody do nowej metody i usunąć starą.

/ Edycja ivo Jak powiedział w komentarzu: Jeszcze lepszym rozwiązaniem byłoby przenieść kod z TheOldMethodNameInto the MyNewMethodNamei wywołać nową metodę od starej. Ten miałby również tę zaletę, że pomógłby deweloperowi dowiedzieć się, gdzie należy kod.

Zmiana nazwy metody:

• Zrób to poprzez refaktoryzację, abyś nie miał więcej pracy niż chcesz
• Jeśli twoje IDE obsługuje automatyczne uzupełnianie, użyj go podczas odwoływania się do tej metody

To są dwie opcje, na które możesz pójść. Wolę automatyczne uzupełnianie (np. Eclipse IDE) i nie muszę wpisywać nazwy metody. Zmieniam nazwę; po prostu upewnij się, że dowiesz się, jakie wywołuje tę metodę i zmienisz bezpośrednie odniesienia w każdym miejscu. Refaktoryzacja będzie twoim przyjacielem, ale bądź ostrożny, robiąc to.

Ogólnie polecam tak, zmień nazwę.

Inne odpowiedzi tutaj wymieniają dobre powody, dla których możesz nie chcieć zmienić jego nazwy, więc jeśli znajdziesz się w takiej sytuacji, możesz utworzyć nową metodę o właściwej nazwie i implementacji oraz zmienić starą metodę, aby wywołać nową metodę . Następnie zaznacz stary jako przestarzały, jeśli Twój język go obsługuje.