Me gustaría saber la mejor manera de agregar un comentario para identificar una clase obsoleta en Java. ¿Debo eliminar el comentario anterior agregado a la parte superior de la clase que ayuda a otro programador a saber para qué era esa clase, o debería agregarlo debajo del comentario?
Respuestas:
El enfoque recomendado para despreciar una clase, método o campo en Java es usar la @Deprecatedanotación, que estuvo disponible en Java 5, o la @deprecatedetiqueta JavaDoc, que ha existido desde Java 1.1. Oracle tiene un documento sobre los detalles sobre cómo y cuándo desaprobar las API que parecen ser relevantes.
¿Debo eliminar el comentario anterior agregado a la parte superior de la clase que ayuda a otro programador a saber para qué era esa clase o agregarlo debajo del comentario?
No debe editar ni eliminar ningún comentario existente, aparte de agregar la etiqueta o anotación JavaDoc. El código obsoleto aún podría estar en uso en sistemas heredados, y los desarrolladores de esos sistemas deben tener acceso a la documentación que los desarrolladores originales hicieron de alguna forma.
@Deprecatedanotación o la @deprecatedetiqueta JavaDoc. Eso es todo, nada más, nada más.
@deprecatedetiqueta y la descripción de JavaDoc junto con la @Deprecatedanotación le dará más luz sobre por qué fue desaprobado. Por lo tanto, sería más beneficioso usar ambos en lugar de solo la @Deprecatedanotación.