I would like to know the best way to add a comment to identify a deprecated class in Java. 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 should I add it below the comment?
- Anybody can ask a question
- Anybody can answer
- The best answers are voted up and rise to the top
The recommended approach to deprecating a class, method, or field in Java is to use the
You should not edit or remove any existing comments, other than to add the JavaDoc tag or annotation. Deprecated code might still be in use in legacy systems, and developers of those systems need to have access to the documentation that the original developers did in some form.