Convenciones de nomenclatura para métodos java que devuelven booleanos (sin signo de interrogación)

Me gusta usar un signo de interrogación al final de los nombres de métodos / funciones en otros idiomas. Java no me deja hacer esto. Como solución alternativa, ¿de qué otra manera puedo nombrar métodos de retorno booleanos en Java? El uso de un is, has, should, canen la parte delantera de un sonido método bien para algunos casos. ¿Existe una mejor manera de nombrar tales métodos?

Por ejemplo, createFreshSnapshot?

La convención es hacer una pregunta en el nombre.

Aquí hay algunos ejemplos que se pueden encontrar en el JDK:

isEmpty()

hasChildren()

De esa manera, los nombres se leen como si tuvieran un signo de interrogación al final.

¿La colección está vacía?
¿Este Nodo tiene hijos?

Y, entonces, truesignifica sí y falsesignifica no.

O puede leerlo como una afirmación:

La colección está vacía.
El nodo tiene hijos

Nota:
A veces es posible que desee nombrar un método como createFreshSnapshot?. Sin el signo de interrogación, el nombre implica que el método debería crear una instantánea, en lugar de verificar si se requiere una.

En este caso, debe repensar lo que realmente está preguntando. Algo como isSnapshotExpiredes un nombre mucho mejor y transmite lo que el método le dirá cuando se lo llame. Seguir un patrón como este también puede ayudar a mantener más funciones puras y sin efectos secundarios.

Si usted hace una búsqueda de Google para isEmpty()la API de Java, se obtiene una gran cantidad de resultados.

Si desea que su clase sea compatible con la especificación de Java Beans , de modo que la utilización de herramientas de reflexión (por ejemplo JavaBuilders , JGoodies Binding ) pueden reconocer captadores de Boole, ya sea para uso getXXXX()o isXXXX()como un nombre de método. De la especificación de Java Beans:

8.3.2 Propiedades booleanas

Además, para las propiedades booleanas, permitimos que un método getter coincida con el patrón:

public boolean is< PropertyName > ();

Este método "es < PropertyName >" puede proporcionarse en lugar de un método "get < PropertyName >", o puede proporcionarse además de un método "get < PropertyName >". En cualquier caso, si el método "is < PropertyName >" está presente para una propiedad booleana, usaremos el método "is < PropertyName >" para leer el valor de la propiedad. Una propiedad booleana de ejemplo podría ser:

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

Quiero publicar este enlace, ya que puede ayudar más a los píos que verifican esta respuesta y buscan más convenciones de estilo Java

Pautas de estilo de programación de Java

El elemento "2.13 es un prefijo que se debe utilizar para las variables y métodos booleanos". es específicamente relevante y sugiere el prefijo is .

La guía de estilo continúa sugiriendo:

Hay algunas alternativas al prefijo is que encajan mejor en algunas situaciones. Estos son los prefijos has , can y should :

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

Si sigue las Pautas, creo que el método apropiado se llamaría:

shouldCreateFreshSnapshot()

Para los métodos que pueden fallar, es decir, si especifica boolean como tipo de retorno, usaría el prefijo try:

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

Para todos los demás casos, use prefijos como is.. has.. was.. can.. allows....

El estándar es el uso de 'es' o 'tiene' como prefijo. Por ejemplo isValid, hasChildren.

ises el que me he encontrado más que ningún otro. Sin embargo, cualquier cosa que tenga sentido en la situación actual es la mejor opción.

Quiero señalar una vista diferente sobre esta convención de nomenclatura general , por ejemplo:

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

donde la justificación es:

Realice algún procesamiento y luego informe si tuvo éxito o no .

Si bien returnes cierto que booleanel nombre del método debe indicar que el procesamiento debe completarse en lugar del tipo de resultado (booleano para este ejemplo).

Su createFreshSnapshotejemplo me parece más relacionado con este punto de vista porque parece significar esto: cree una instantánea nueva y luego informe si la operación de creación tuvo éxito. Teniendo en cuenta este razonamiento, el nombre createFreshSnapshotparece ser el mejor para su situación.