Convenzioni di denominazione per metodi java che restituiscono booleano (nessun punto interrogativo)

Mi piace usare il punto interrogativo alla fine dei nomi di metodi / funzioni in altre lingue. Java non mi permette di farlo. Come soluzione alternativa, in quale altro modo posso denominare metodi di restituzione booleani in Java? L'utilizzo di un is, has, should, cannella parte anteriore di un suono metodo va bene per alcuni casi. C'è un modo migliore per nominare tali metodi?

Ad esempio, createFreshSnapshot?

La convenzione è fare una domanda nel nome.

Ecco alcuni esempi che possono essere trovati nel JDK:

isEmpty()

hasChildren()

In questo modo, i nomi vengono letti come se avessero un punto interrogativo alla fine.

La raccolta è vuota?
Questo nodo ha figli?

E, quindi, truesignifica sì e falsesignifica no.

Oppure potresti leggerlo come un'affermazione:

La raccolta è vuota.
Il nodo ha figli

Nota: a
volte potresti voler nominare un metodo qualcosa come createFreshSnapshot?. Senza il punto interrogativo, il nome implica che il metodo dovrebbe creare un'istantanea, invece di verificare se è necessaria.

In questo caso dovresti ripensare a ciò che stai effettivamente chiedendo. Qualcosa di simile isSnapshotExpiredè un nome molto migliore e trasmette ciò che il metodo ti dirà quando viene chiamato. Seguire uno schema come questo può anche aiutare a mantenere più pure le tue funzioni e senza effetti collaterali.

Se fate una ricerca di Google per isEmpty()la Java API, si ottiene un sacco di risultati.

Se desideri che la tua classe sia compatibile con la specifica Java Beans , in modo che gli strumenti che utilizzano la reflection (ad esempio JavaBuilders , JGoodies Binding ) possano riconoscere i getter booleani, utilizzare getXXXX()o isXXXX()come nome del metodo. Dalle specifiche Java Beans:

8.3.2 Proprietà booleane

Inoltre, per le proprietà booleane, consentiamo a un metodo getter di abbinare il modello:

public boolean is< PropertyName > ();

Questo metodo "is < PropertyName >" può essere fornito invece di un metodo "get < PropertyName >", oppure può essere fornito in aggiunta a un metodo "get < PropertyName >". In entrambi i casi, se il metodo "is < PropertyName >" è presente per una proprietà booleana, utilizzeremo il metodo "is < PropertyName >" per leggere il valore della proprietà. Una proprietà booleana di esempio potrebbe essere:

public boolean isMarsupial();
public void setMarsupial(boolean m);

Voglio pubblicare questo collegamento in quanto può aiutare ulteriormente per i peep che controllano questa risposta e cercano più convenzioni in stile java

Linee guida sullo stile di programmazione Java

L'elemento "2.13 è prefisso deve essere utilizzato per variabili e metodi booleani". è specificamente rilevante e suggerisce il prefisso is .

La guida allo stile prosegue suggerendo:

Ci sono alcune alternative al prefisso is che si adatta meglio in alcune situazioni. Questi sono prefissi has , can e should :

boolean hasLicense();
boolean canEvaluate();
boolean shouldAbort = false;

Se segui le linee guida, credo che il metodo appropriato verrebbe chiamato:

shouldCreateFreshSnapshot()

Per i metodi che potrebbero non riuscire, ovvero specificare booleano come tipo di ritorno, utilizzerei il prefisso try:

if (tryCreateFreshSnapshot())
{
  // ...
}

Per tutti gli altri casi, utilizza prefissi come is.. has.. was.. can.. allows....

Lo standard è utilizzare "è" o "ha" come prefisso. Per esempio isValid, hasChildren.

isè quello che ho incontrato più di ogni altro. Tuttavia, qualunque cosa abbia senso nella situazione attuale è l'opzione migliore.

Voglio puntare una visione diversa su questa convenzione di denominazione generale , ad esempio:

vedi java.util.Set :boolean add​(E e)

dove la logica è:

eseguire alcune elaborazioni, quindi segnalare se è riuscita o meno .

Sebbene returnsia effettivamente un booleanil nome del metodo dovrebbe indicare l'elaborazione da completare invece del tipo di risultato (booleano per questo esempio).

Il tuo createFreshSnapshotesempio mi sembra più correlato a questo punto di vista perché sembra significare questo: crea una nuova istantanea, quindi segnala se l'operazione di creazione è riuscita. Considerando questo ragionamento il nome createFreshSnapshotsembra essere il migliore per la tua situazione.