Built-in Java Annotations: @Deprecated example

The @Deprecated annotation will be used to inform the compiler to generate a warning whenever a program uses a method, class, or field with the @Deprecated annotation. It is good to document the reason with Javadoc @deprecated tag. Make a note of case difference with @Deprecated and @deprecated. @deprecated is for documentation purpose.

package com.java2novice.annotations;

public class MyDeprecatedExmp {
	
	/**
     * @deprecated
     * reason for why it was deprecated
     */
	@Deprecated
	public void showDeprecatedMessage(){
		System.out.println("This method is marked as deprecated");
	}
	
	public static void main(String a[]){
		
		MyDeprecatedExmp mde = new MyDeprecatedExmp();
		mde.showDeprecatedMessage();
	}
}