Convenciones de codificación - Enumeración de nombres

Question

¿Existe una convención para nombrar enumeraciones en Java?

Mi preferencia es que una enumeración es un tipo. Así, por ejemplo, tiene una enumeración

Fruit{Apple,Orange,Banana,Pear, ... } 

NetworkConnectionType{LAN,Data_3g,Data_4g, ... } 

me opongo a nombrarlo:

FruitEnum 
NetworkConnectionTypeEnum 

entiendo que es fácil de escoger de qué archivos son enumeraciones, pero entonces también habría que:

NetworkConnectionClass 
FruitClass 

Además, ¿hay un buen documento que describe el mismo para las constantes, donde declararlos, etc.?

Answer 1

Los enumerados son clases y deben seguir las convenciones de las clases. Las instancias de una enumeración son constantes y deben seguir las convenciones para las constantes. Entonces

enum Fruit {APPLE, ORANGE, BANANA, PEAR}; 

No hay razón para escribir FruitEnum más que FruitClass. Solo desperdicia cuatro (o cinco) caracteres que no agregan información.

Java mismo recomienda este enfoque y es used in their examples.

Answer 2

En nuestra base de código; por lo general, declaramos enumeraciones en la clase a la que pertenecen.

Así que para su ejemplo de Fruta, tendríamos una clase de Frutas, y dentro de eso un Enum llamado Frutas.

referencia a ella en el código es el siguiente: Fruit.Fruits.Apple, Fruit.Fruits.Pear, etc.

Constantes siguen en la misma línea, en el que o bien obtener definen en la clase a la que son relevantes (así que algo como Fruit.ORANGE_BUSHEL_SIZE); o si se aplican a todo el sistema (es decir, un "valor nulo" equivalente para ints) en una clase llamada "ConstantManager" (o equivalente, como ConstantManager.NULL_INT). (nota al margen; todas nuestras constantes están en mayúsculas)

Como siempre, sus estándares de codificación probablemente difieran de los míos; así que YMMV.

Answer 3

Todavía son tipos, por lo que siempre uso las mismas convenciones de nomenclatura que uso para las clases.

Definitivamente frunciría el ceño al poner "Clase" o "Enum" en un nombre. Si tiene un FruitClass y un FruitEnum, entonces algo más está mal y necesita más nombres descriptivos. Estoy tratando de pensar sobre el tipo de código que llevaría a necesitar ambos, y parece que debería haber una clase base Fruit con subtipos en lugar de una enumeración. (Eso es sólo mi propia especulación, sin embargo, es posible que tenga una situación diferente a lo que estoy imaginando.)

La mejor referencia que puedo encontrar para nombrar constantes proviene de la Variables tutorial:

Si el nombre eliges que consiste de una sola palabra, deletrea esa palabra en letras minúsculas. Si consta de más de una palabra, escribe en mayúscula la primera letra de cada palabra siguiente. Los nombres gearRatio y currentGear son ejemplos principales de esta convención. Si su variable almacena un valor constante, como static final int NUM_GEARS = 6, la convención cambia ligeramente, capitalizando cada letra y separando palabras subsecuentes con el carácter de subrayado. Por convención, el carácter de subrayado nunca se usa en ningún otro lado.

Answer 4

Esto probablemente no me hará muchos nuevos amigos, pero debería agregarse que las personas C# tienen una pauta diferente: Las instancias enum son "caso Pascal" (mayúsculas/minúsculas mezcladas). Ver stackoverflow discussion y MSDN Enumeration Type Naming Guidelines.

Como estamos intercambiando datos con un sistema C#, estoy tentado de copiar sus enumeraciones exactamente, ignorando las convenciones de Java de que "las constantes tienen nombres en mayúscula". Al pensar en ello, no veo mucho valor en restringirme a mayúsculas para las instancias enum. Para algunos fines .name() es un atajo útil para obtener una representación legible de una constante enum y un nombre de caso mixto se vería mejor.

Entonces, sí, me atrevo a cuestionar el valor de la convención de nomenclatura enum de Java. El hecho de que "la otra mitad del mundo de la programación" sí utiliza un estilo diferente me hace pensar que es legítimo dudar de nuestra propia religión.

Answer 5

Como ya se indicó, las instancias enum deberían estar en mayúsculas de acuerdo con los documentos en el sitio web de Oracle (http://docs.oracle.com/javase/tutorial/java/javaOO/enum.html).

Sin embargo, mientras que mirando a través de un tutorial JavaEE7 en el sitio web de Oracle (http://www.oracle.com/technetwork/java/javaee/downloads/index.html), me encontré con tutorial de la "de Duke librería" y en una clase (tutorial\examples\case-studies\dukes-bookstore\src\main\java\javaeetutorial\dukesbookstore\components\AreaComponent.java), me encontré con la siguiente definición de enumeración:

private enum PropertyKeys { 
    alt, coords, shape, targetImage; 
} 

de acuerdo con las convenciones, debe haber parecido:

public enum PropertyKeys { 
    ALT("alt"), COORDS("coords"), SHAPE("shape"), TARGET_IMAGE("targetImage"); 

    private final String val; 

    private PropertyKeys(String val) { 
     this.val = val; 
    } 

    @Override 
    public String toString() { 
     return val; 
    } 
} 

Por lo que parece, incluso los chicos de Oracle convención veces comercian con la conveniencia.