Leggibilità dei nomi dei metodi booleani

Domanda semplice, dal punto di vista della leggibilità, quale nome di metodo preferisci per un metodo booleano:

public boolean isUserExist(...)

o:

public boolean doesUserExist(...)

o:

public boolean userExists(...)

public boolean userExists(...)

Sarebbe il mio preferito. Poiché rende i tuoi controlli condizionali molto più simili all'inglese naturale:

if userExists ...

Ma immagino che non ci sia una regola rigida e veloce: sii coerente

Direi userExists, perché il 90% delle volte il mio codice chiamante sarà simile a questo:

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

e si legge molto letteralmente in inglese.

if isUserExiste if doesUserExistsembrano ridondanti.

Attenzione a sacrificare la chiarezza mentre si insegue la leggibilità .

Anche se if (user.ExistsInDatabase(db))legge più bene di if (user.CheckExistsInDatabase(db)), considera il caso di una classe con un modello di generatore (o qualsiasi classe su cui puoi impostare lo stato):

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

Non è chiaro se ExistsInDatabasesta controllando se esiste o se sta impostando il fatto che esiste. Non scriveresti if (user.Age())o if (user.Name())senza alcun valore di confronto, quindi perché è if (user.Exists())una buona idea semplicemente perché quella proprietà / funzione è di tipo booleano e puoi rinominare la funzione / proprietà per leggere più come l'inglese naturale? È così brutto seguire lo stesso schema che usiamo per altri tipi diversi dai booleani?

Con altri tipi, ifun'istruzione confronta il valore restituito di una funzione con un valore nel codice, quindi il codice ha un aspetto simile a:

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

Che si legge come "se il punto dell'utente ottiene l'età è maggiore o uguale a 18 ..." vero - non è "inglese naturale", ma direi che object.verbnon ha mai assomigliato all'inglese naturale e questo è semplicemente un aspetto fondamentale della programmazione moderna (per molte lingue tradizionali). I programmatori generalmente non hanno problemi a comprendere l'affermazione di cui sopra, quindi la seguente è peggio?

if (user.CheckExists() == true)

Che normalmente è abbreviato in

if (user.CheckExists())

Seguito dal passo fatale

if (user.Exists())

Sebbene sia stato detto che "il codice viene letto 10 volte più spesso di quanto scritto", è anche molto importante che i bug siano facili da individuare. Supponi di avere una funzione chiamata Exists () che fa sì che l'oggetto esista e restituisce vero / falso in base al successo. Potresti facilmente vedere il codice if (user.Exists())e non individuare il bug: il bug sarebbe molto più ovvio se il codice fosse letto if (user.SetExists())per esempio.

Inoltre, user.Exists () potrebbe facilmente contenere codice complesso o inefficiente, facendo un giro in un database per controllare qualcosa. user.CheckExists () rende chiaro che la funzione fa qualcosa.

Vedere anche tutte le risposte qui: Convenzioni di denominazione: come denominare un metodo che restituisce un valore booleano?

Come nota finale - dopo "Tell Don't Ask", molte delle funzioni che restituiscono true / false scompaiono comunque, e invece di chiedere a un oggetto il suo stato, gli dici di fare qualcosa, cosa che può fare in modo diverso modi in base al suo stato.

L'obiettivo della leggibilità dovrebbe sempre essere quello di scrivere il codice il più vicino possibile al linguaggio naturale. Quindi, in questo caso, userExistssembra la scelta migliore. L'uso del prefisso "è" può comunque essere corretto in altre situazioni, ad esempio isProcessingComplete.

Vorrei usare userExists () perché 1) ha senso in linguaggio naturale e 2) segue le convenzioni delle API che ho visto.

Per vedere se ha senso nel linguaggio naturale, leggilo ad alta voce. "Se l'utente esiste" suona più come una frase inglese valida di "se l'utente esiste" o "se l'utente esiste". "Se l'utente esiste" sarebbe meglio, ma "il" è probabilmente superfluo nel nome di un metodo.

Per vedere se esiste un file in Java SE 6, dovresti usare File.exists () . Sembra che sarà lo stesso nella versione 7 . C # usa la stessa convenzione , come fanno Python e Ruby . Si spera che questa sia una raccolta abbastanza diversificata da definirla una risposta indipendente dalla lingua. In generale, mi schiererei con i metodi di denominazione in linea con l'API della tua lingua.

Ci sono cose da considerare che penso siano mancate da molte altre risposte qui

1. Dipende se si tratta di un metodo di classe C ++ o di una funzione C. Se questo è un metodo, probabilmente verrà chiamato if (user.exists()) { ... }o if (user.isExisting()) { ... }
   meno if (user_exists(&user)). Questa è la ragione dietro gli standard di codifica per cui i metodi bool di stato dovrebbero iniziare con un verbo poiché si leggeranno come una frase quando l'oggetto è davanti a loro.

2. Sfortunatamente molte vecchie funzioni C restituiscono 0 per il successo e diverso da zero per il fallimento quindipuòessere difficile determinare lo stile utilizzato a meno che tu non segua tutte le funzioni bool che iniziano con i verbi o si confrontano sempre con true in questo modo if (true == user_exists(&user))

La mia semplice regola a questa domanda è questa:

Se il metodo booleano HA già un verbo, non aggiungerne uno. Altrimenti, consideralo. Qualche esempio:

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

Puramente soggettivo.

Preferisco userExists(...)perché poi affermazioni come questa leggono meglio:

if ( userExists( ... ) )

o

while ( userExists( ... ) )

In questo caso particolare, il primo esempio è un inglese così orribile che mi fa trasalire.

Probabilmente sceglierei il numero tre per come suona quando lo leggo nelle istruzioni if. "Se l'utente esiste" suona meglio di "Se l'utente esiste".

Questo presuppone che verrà utilizzato nei test dell'istruzione if ovviamente ...

Mi piace uno di questi:

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

I nomi dei metodi servono per la leggibilità, solo quelli che si adattano all'intero codice sarebbero i migliori, che nella maggior parte dei casi inizia con condizioni, quindi subjectPredicate segue la struttura naturale della frase.

Allora perché non rinominare la proprietà?

if (user.isPresent()) {