Czytelność nazewnictwa metod logicznych

Proste pytanie, z punktu widzenia czytelności, jaką nazwę preferujesz dla metody logicznej:

public boolean isUserExist(...)

lub:

public boolean doesUserExist(...)

lub:

public boolean userExists(...)

public boolean userExists(...)

Wolałbym. Ponieważ sprawia, że ​​testy warunkowe bardziej przypominają naturalny angielski:

if userExists ...

Ale myślę, że nie ma sztywnej i szybkiej zasady - po prostu bądź konsekwentny

Powiedziałbym userExists, ponieważ w 90% przypadków mój kod wywoławczy będzie wyglądał tak:

if userExists(...) {
  ...
}

i brzmi bardzo dosłownie po angielsku.

if isUserExisti if doesUserExistwydają się zbędne.

Uważaj, aby nie tracić przejrzystości , dążąc do czytelności .

Chociaż if (user.ExistsInDatabase(db))czyta ładniej niż if (user.CheckExistsInDatabase(db)), rozważ przypadek klasy ze wzorcem budującym (lub dowolną klasą, na którą możesz ustawić stan):

user.WithName("Mike").ExistsInDatabase(db).ExistsInDatabase(db2).Build();

Nie jest jasne, czy ExistsInDatabasechodzi o sprawdzenie, czy istnieje, czy o ustalenie faktu, że istnieje. Nie zapisałbyś if (user.Age())ani if (user.Name())bez wartości porównawczej, więc dlaczego jest if (user.Exists())to dobry pomysł tylko dlatego, że ta właściwość / funkcja jest typu boolowskiego i możesz zmienić nazwę funkcji / właściwości, aby bardziej przypominała naturalny angielski? Czy to źle podążać za tym samym wzorcem, którego używamy dla innych typów niż logiczne?

W przypadku innych typów ifinstrukcja porównuje zwracaną wartość funkcji z wartością w kodzie, więc kod wygląda mniej więcej tak:

if (user.GetAge() >= 18) ...

Czyli „jeśli użytkownik dot get wiek jest większy lub równy 18 ...” prawda - to nie jest „naturalny angielski”, ale twierdziłbym, że object.verbnigdy nie przypominał naturalnego angielskiego i jest to po prostu podstawowy aspekt współczesnego programowania (np. wielu popularnych języków). Programiści generalnie nie mają problemu ze zrozumieniem powyższego stwierdzenia, więc czy następujące jest gorsze?

if (user.CheckExists() == true)

Który jest zwykle skracany do

if (user.CheckExists())

Następuje fatalny krok

if (user.Exists())

Chociaż powiedziano, że „kod jest czytany 10 razy częściej niż pisany”, bardzo ważne jest również, aby błędy były łatwe do wykrycia. Załóżmy, że masz funkcję o nazwie Exists (), która powoduje, że obiekt istnieje i zwraca wartość true / false na podstawie sukcesu. Możesz łatwo zobaczyć kod if (user.Exists())i nie zauważyć błędu - błąd byłby znacznie bardziej oczywisty, gdyby kod był czytany if (user.SetExists())na przykład.

Dodatkowo user.Exists () może z łatwością zawierać złożony lub nieefektywny kod, przechodząc do bazy danych w celu sprawdzenia czegoś. user.CheckExists () wyjaśnia, że ​​funkcja coś robi.

Zobacz także wszystkie odpowiedzi tutaj: Konwencje nazewnictwa: Jak nazwać metodę, która zwraca wartość logiczną?

Na koniec - po „Tell Don't Ask” wiele funkcji, które zwracają prawda / fałsz, i tak znika, a zamiast pytać obiekt o jego stan, każesz mu zrobić coś, co może zrobić w inny sposób sposoby oparte na jego stanie.

Celem czytelności zawsze powinno być pisanie kodu jak najbardziej zbliżonego do języka naturalnego. Więc w tym przypadku userExistswydaje się najlepszym wyborem. Jednak użycie przedrostka „jest” może być poprawne, na przykład w innych sytuacjach isProcessingComplete.

Wybrałbym userExists (), ponieważ 1) ma to sens w języku naturalnym i 2) jest zgodne z konwencjami API, które widziałem.

Aby sprawdzić, czy ma to sens w języku naturalnym, przeczytaj to na głos. „Jeśli użytkownik istnieje” brzmi bardziej jak poprawne angielskie wyrażenie niż „jeśli użytkownik istnieje” lub „jeśli istnieje użytkownik”. „Jeśli użytkownik istnieje” byłoby lepsze, ale „the” jest prawdopodobnie zbędne w nazwie metody.

Aby sprawdzić, czy plik istnieje w Java SE 6, należy użyć funkcji File.exists () . Wygląda na to, że będzie tak samo w wersji 7 . C # używa tej samej konwencji , co Python i Ruby . Miejmy nadzieję, że jest to zbiór wystarczająco zróżnicowany, aby nazwać to odpowiedzią niezależną od języka. Ogólnie rzecz biorąc, byłbym po stronie metod nazewnictwa zgodnych z API twojego języka.

Są rzeczy do rozważenia, o których myślę, że pominęło kilka innych odpowiedzi

1. Zależy to od tego, czy jest to metoda klasy C ++, czy funkcja C. Jeśli jest to metoda, prawdopodobnie zostanie wywołana if (user.exists()) { ... }lub if (user.isExisting()) { ... }
   nie if (user_exists(&user)). To jest powód, dla którego standardy kodowania określają, że metody bool powinny zaczynać się od czasownika, ponieważ będą one czytane jak zdanie, gdy obiekt będzie przed nimi.

2. Niestety wiele starych funkcji C zwraca 0 dla sukcesu i niezerowe dla niepowodzenia, więc może być trudne określenie używanego stylu, chyba że śledzisz wszystkie funkcje bool zaczynające się od czasowników lub zawsze porównując z prawdą w ten sposób if (true == user_exists(&user))

Moja prosta zasada na to pytanie jest taka:

Jeśli metoda boolowska ma już czasownik, nie dodawaj go. W przeciwnym razie rozważ to. Kilka przykładów:

$user->exists()
$user->loggedIn()
$user->isGuest() // "is" added

Czysto subiektywne.

Wolę, userExists(...)bo wtedy takie stwierdzenia czytaj lepiej:

if ( userExists( ... ) )

lub

while ( userExists( ... ) )

W tym konkretnym przypadku pierwszym przykładem jest tak okropny angielski, że aż się krzywię.

Prawdopodobnie wybrałbym numer trzy ze względu na to, jak to brzmi podczas czytania stwierdzeń if. „Jeśli użytkownik istnieje” brzmi lepiej niż „Jeśli użytkownik istnieje”.

Zakłada się, że będzie on używany w testach instrukcji jeśli oczywiście ...

Podoba mi się każdy z tych:

userExists(...)
isUserNameTaken(...)
User.exists(...)
User.lookup(...) != null

Nazwy metod służą czytelności, najlepiej pasowałyby tylko te, które pasują do całego kodu, które w większości przypadków zaczynają się od warunków, więc subjectPredicate ma naturalną strukturę zdania.

Dlaczego więc nie zmienić nazwy nieruchomości?

if (user.isPresent()) {