dcsimg
TODAY'S HEADLINES  |   ARTICLE ARCHIVE  |   FORUMS  |   TIP BANK
Browse DevX
Sign up for e-mail newsletters from DevX


Tip of the Day
Language: Java
Expertise: Beginner
Mar 7, 2003

WEBINAR:

On-Demand

Building the Right Environment to Support AI, Machine Learning and Deep Learning


Use the Deprecation Tag to Warn of Code Changes


When you need to change the parameters or name of a class or method you developed use the javadoc @deprecated tag and leave the old code. This allows other to be warned that they need to update their code without having to break a build process.

The following code illustrates its usage:
 
  /**
   * Adds a resouce to list.
   *
   * @deprecated replaced by <code>addResource(String, String)</code>.
   */
  public void addResource( String name )
  {
     ...
  }

If you use the old method, you will get this message from the compiler:
 
C:\tips>javac Test.java
Note: Test.java uses or overrides a deprecated API.
Note: Recompile with -deprecation for details.

Be sure to comment the reason for the change and the replacement method that should be used.
Peter Gray
 
Comment and Contribute

 

 

 

 

 


(Maximum characters: 1200). You have 1200 characters left.

 

 

Thanks for your registration, follow us on our social networks to keep up-to-date