Czy ponowne stosowanie parametrów metody jest złą praktyką?

Są chwile, kiedy będę musiał zmodyfikować wartość przekazywaną do metody z poziomu samej metody. Przykładem może być tutaj odkażanie łańcucha, takiego jak ta metoda:

void SanitizeName(string Name)
{
    Name = Name.ToUpper();

    //now do something here with name
}

Jest to całkowicie nieszkodliwe, ponieważ Nameargument nie jest przekazywany przez odwołanie. Jeśli jednak z jakiegoś powodu programista w przyszłości zdecyduje się na przekazanie wszystkich wartości przez ref, wszelkie odkażanie łańcucha wpłynie na wartość poza metodą, co może mieć szkodliwe wyniki.

Dlatego zamiast przypisywania samego argumentu zawsze tworzę lokalną kopię w następujący sposób:

void SanitizeName(string Name)
{
    var SanitizedName = Name.ToUpper();

    //now do something here with name
}

Zapewnia to, że zmiana przekazu wartości nigdy nie wpłynie na działania poza metodą, ale zastanawiam się, czy jestem nadmiernie paranoikiem na ten temat.

Myślę, że to zależy od twoich konwencji kodowania w twoim projekcie.

Osobiście pozwalam eclipse automatycznie dodawać finalsłowo kluczowe do każdej zmiennej i parametru. W ten sposób na pierwszy rzut oka widać, czy parametr jest ponownie używany.

W projekcie w moim zadaniu nie zalecamy ponownego użycia parametrów, ale jeśli chcesz tylko wywołać np. .trim()Lub ustawić wartość domyślną w nullprzypadku, to najczęściej używamy parametru ponownie, ponieważ wprowadzenie nowej zmiennej jest w takich przypadkach mniej czytelne niż ponowne użycie parametru.

Naprawdę nie powinieneś ponownie używać parametru do przechowywania bardzo różnych treści, ponieważ nazwa nie będzie już odnosić się do jego zawartości. Ale dotyczy to każdego ponownego przypisania zmiennej i nie ogranicza się do parametrów.

Spotkaj się więc ze swoim zespołem i sformułuj konwencje kodowania dotyczące tej kwestii.

Jeśli używasz statycznego analizatora kodu ze względów bezpieczeństwa, może się on pomylić i sądzić, że nie sprawdziłeś poprawności lub dezynfekcji zmiennej parametru wejściowego przed użyciem. Jeśli użyjesz Namena przykład zapytania SQL, może ono zawierać lukę w zabezpieczeniach polegającą na wstrzykiwaniu SQL, co może być czasochłonne w wyjaśnieniu. To jest złe. Z drugiej strony, użycie specjalnie nazwanej zmiennej do dezynfekowanego wejścia, bez dezynfekcji danych wejściowych, jest szybkim sposobem na wyciszenie naiwnych analizatorów kodu (wykrywanie podatności na fałszywe negatywne).

Odpowiedź na to pytanie zależy w 100% od tego, kto będzie czytał Twój kod. Jakie style uważają za najbardziej pomocne?

Odkryłem, że najbardziej ogólny przypadek polega na tym, że unika się ponownego przypisywania wartości do argumentów funkcyjnych, ponieważ zbyt wielu programistów ma mentalne modele działania wywołań funkcji, które zakładają, że nigdy tego nie robisz. Ten problem może spotęgować debuggery, które wypisują wartości argumentów, które wywołujesz dla każdej funkcji. Informacje te są technicznie niepoprawne, jeśli edytujesz argumenty, co może prowadzić do dziwnych frustracji.

Biorąc to pod uwagę, zmieniają się modele mentalne. W twoim konkretnym środowisku programistycznym może być pożądane, aby namebyć „najlepszą reprezentacją nazwy w tym momencie”. Może być pożądane wyraźniejsze powiązanie zmiennych, nad którymi pracujesz, z ich argumentami, nawet jeśli po drodze wprowadziłeś pewne modyfikacje ich wartości. Ponowne użycie niektórych określonych zmiennych może być nawet znaczące. W końcu, gdy pracujesz z ciągami 4 GB, miło jest zminimalizować liczbę dodatkowych kopii, które musisz wykonać!

Mam zupełnie inny problem z twoim przykładem kodu:

Twoja metoda nazywa się SanitizeName. W tym przypadku oczekuję, że zdezynfekuje ono imię ; ponieważ to jest to, co mówisz czytelnikowi o swojej funkcji.

Tylko rzeczą, której funkcjonować należy zrobić , jest odkażania daną nazwę . Bez czytania kodu oczekiwałbym:

string SanitizeName(string Name)
{
    //somehow sanitize the name
    return Result;
}

Ale sugerujesz, że twoja metoda robi coś więcej niż tylko dezynfekcję. To zapach kodu i należy go unikać.

Twoje pytanie nie dotyczy: Czy złą praktyką jest ponowne wykorzystywanie parametrów metody? Co więcej: czy skutki uboczne i nieoczekiwane zachowanie są złą praktyką?

Odpowiedź na to pytanie jest jednoznaczna: tak!

Jest to całkowicie nieszkodliwe, ponieważ argument Nazwa nie jest przekazywany przez odwołanie. Jeśli jednak z jakiegoś powodu programista w przyszłości zdecyduje się na przekazanie wszystkich wartości przez ref, wszelkie odkażanie łańcucha wpłynie na wartość poza metodą, co może mieć szkodliwe wyniki

Wprowadzasz czytelnika w błąd, nie zwracając niczego. Twoja nazwa metody wyraźnie wskazuje, że coś robiszName . Gdzie więc powinien iść wynik? Przez twoją funkcję voidczyta podpis, którego używam, Nameale nie wyrządzam żadnej szkody idowi, ani nie mówię ci o wyniku (jawnie). Być może istnieje wyjątek, a może nie; ale Namenie ulega zmianie . Jest to semantyczne przeciwieństwo nazwy twojej metody.

Problemem jest mniejsze ponowne użycie niż skutki uboczne . Aby zapobiec efektom ubocznym , nie używaj ponownie zmiennej. Jeśli nie masz żadnych skutków ubocznych, nie ma problemu.