Vorrei sapere il modo migliore per aggiungere un commento per identificare una classe deprecata in Java. Devo rimuovere il commento precedente aggiunto all'inizio della classe che aiuta un altro programmatore a sapere a cosa serviva quella classe o dovrei aggiungerlo sotto il commento?
Risposte:
L'approccio raccomandato per deprecare una classe, un metodo o un campo in Java è utilizzare l' @Deprecatedannotazione, che è diventata disponibile in Java 5, o il @deprecatedtag JavaDoc, che esiste da Java 1.1. Oracle ha un documento sulle specifiche su come e quando deprezzare le API che sembrano essere rilevanti.
Devo rimuovere il commento precedente aggiunto all'inizio della classe che aiuta un altro programmatore a sapere a cosa serviva quella classe o aggiungerlo sotto il commento?
Non è necessario modificare o rimuovere eventuali commenti esistenti, se non per aggiungere il tag o l'annotazione JavaDoc. Il codice obsoleto potrebbe essere ancora in uso nei sistemi legacy e gli sviluppatori di tali sistemi devono avere accesso alla documentazione che gli sviluppatori originali hanno fatto in qualche modo.
@Deprecatedannotazione o il @deprecatedtag JavaDoc. Questo è tutto - nient'altro, niente di più.
@deprecatedtag e descrizione JavaDoc insieme @Deprecatedall'annotazione darà più luce sul perché è stato deprecato. Quindi sarebbe più utile usare entrambi anziché solo @Deprecatedannotazioni.