usar - javadoc pdf
¿Cuál es la mejor manera de utilizar JavaDoc para documentar una enumeración de Java? (3)
Acabo de empezar a usar las enumeraciones de Java en mis propios proyectos (tengo que usar JDK 1.4 en el trabajo) y estoy confundido en cuanto a la mejor práctica de usar JavaDoc para una enumeración.
He descubierto que este método funciona, pero el código resultante es un poco refinado:
/**
* Doc for enum
*/
public enum Something {
/**
* First thing
*/
FIRST_THING,
/**
* Second thing
*/
SECOND_THING;
//could continue with more
}
¿Hay alguna forma de que pueda dividir las declaraciones enum en sus propias líneas sin encadenarlas con comas, o este es el mejor método para usar JavaDoc para una enumeración?
Como mencionó Mike, debe separar los valores enum con comas, y tienen que ser los primeros enunciados en la declaración enum (pueden seguir variables de instancia, constantes, constructores y métodos).
Creo que la mejor manera de documentar enumeraciones es similar a las clases regulares: el tipo enum obtiene una descripción de la función y el rol de la enumeración como un todo ("Los Something values are used to indicate which mode of operation a client wishes... " ) y cada valor enum obtiene una descripción Javadoc de su propósito y función (" FIRST_THING indicates that the operation should evaluate the first argument first.. ").
Si las descripciones del valor de la enumeración son cortas, puede colocarlas en una línea como /** Evaluate first argument first. */ /** Evaluate first argument first. */ , pero recomiendo mantener cada valor enum en su propia línea. La mayoría de los IDE se pueden configurar para formatearlos de esta manera automáticamente.
Para responder la primera parte de su pregunta, debe separar cada valor enum con una coma. Hasta donde yo sé, no hay forma de evitar eso.
Personalmente, no tengo un problema con el código de la forma en que lo has presentado. Parece una forma perfectamente razonable de documentarme una enumeración.
Hay una herramienta en línea de búsqueda de códigos de google: http://www.google.com/codesearch
Intento buscar cosas haciendo algo como "lang: java public enum"