¿Cuál es la mejor manera de comentar una clase obsoleta en Java?

11

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?

java code-quality api comments alculete
fuente

Respuestas:

17

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.

Thomas Owens
fuente
1
+1: El uso de las anotaciones @Depricated también le da un aviso a IDEs como Eclipse para asegurarse de tachar ese método y dar otras sugerencias visuales a los desarrolladores.
Ryan Hayes
sí, sé cómo desaprobar y el uso de la anotación mi pregunta es, por ejemplo, tengo este código / ** * comentario sobre la clase ** / public class ClassToDeprecate {// algún código aquí} en caso de que elimine el comentario y sea así
Alculete
1
@Spammer El artículo al que lo vinculé trata sobre eso. Además, navegar por la documentación de la API de Java responde a eso. Lo único que debe hacer es agregar la @Deprecatedanotación o la @deprecatedetiqueta JavaDoc. Eso es todo, nada más, nada más.
Thomas Owens
por cierto, el enlace que diste fue muy útil
alculete
1
Agregar la @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.
WarFox