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 per cosa è stata quella classe, o dovrei aggiungerlo sotto il commento?
L'approccio raccomandato per deprecare una classe, un metodo o un campo in Java consiste nell'utilizzare l'annotazione @Deprecated , che è diventata disponibile in Java 5, o il tag% id_de% JavaDoc, che è presente da Java 1.1. Oracle ha un documento sulle specifiche su come e quando deprecare le API che sembra pertinente.
Should i remove the previous comment added to the top of the class that helps another programmer to know what was that class for or add it below the comment?
Non è necessario modificare o rimuovere alcun commento esistente, se non per aggiungere il tag o annotazione JavaDoc. Il codice deprecato potrebbe ancora essere utilizzato nei sistemi legacy e gli sviluppatori di tali sistemi devono avere accesso alla documentazione che gli sviluppatori originali hanno fatto in qualche modo.
Leggi altre domande sui tag code-quality java api comments