[Duda] Documentación | Java y java.lang: Programe con la clase Object y String

/** Instancia una nueva cuenta sin parametros @param agencia @param numero*/ public Cuenta(int agencia, int numero) { this.agencia = agencia; this.numero = numero; System.out.println("Creando cuenta ONE =] " + this.numero); Cuenta.total ++; }

/** @Description Instancia una nueva cuenta sin parametros @param agencia @param numero*/ public Cuenta(int agencia, int numero) { this.agencia = agencia; this.numero = numero; System.out.println("Creando cuenta ONE =] " + this.numero); Cuenta.total ++; }

Hola Zack, espero que estés bien.

Felicitaciones por tu aprendizaje, gracias por compartir con nosotros, eso enriquece nuestros conocimientos. Continúa con ese empeño.

Sí, la descripción es un concepto que implica buenas prácticas de programación. El uso de esta convencion ayuda a lograr una mejor legibilidad de los programas, y aumenta considerablemente la calidad en su documentación interna.

@Target({TYPE,FIELD,METHOD})         //TIPO, CAMPO, MÉTODO 
@Retention(RUNTIME)                          //TIEMPO DE EJECUCIÓN

@interfaz pública Descripción extiende java.lang.annotation.Annotation

Uso:

La anotación @Description se aplica a los métodos en la interfaz MBean:

@Description("El tamaño máximo permitido, en bytes, de un valor binario.")
int getMaxValueSize();

Así como para la interfaz MBean en su conjunto:

@Description("El RamJournalRMMBean proporciona métricas específicas de RamJournal")
interfaz pública RamJournalRMMBean

Puede incluir comentarios en el programa también, pero obviamente, los comentarios deben ser suficientes para permitirle al lector entender lo que el programa hace. Sin embargo, todos los comentarios deben cumplir con lo siguiente:

Deben ser completos, claros, válidos, coherentes, pertinentes...

Un saludo.

Si este post te ayudó, por favor, marca como solucionado ✓. Continúa con tus estudios.