How to mark as deprectated?

[Danl Thompson]

How to I show something to be deprecated? I've got some class A, with some method getIndex(), and I want to declare it to be deprecated. Can't seem to find out how to do it.

[Sayed Ibrahim Hashimi]

The your javadoc comment section directly before the method signature should look like:

/**
* A method that I wrote!!!
* @param someInt Description of the int.
* @deprecated This method is now deprecated, it has been replaced by myNewMethod(int).
*/
public void myMethod(int someInt)
{...}

Just add the @deprecated tag, and when the compiler compiles it will let you know that you are using deprecated methods. But you have to keep in mind that since a method is deprecated, that is doing nothing to stop someone from using it.
Hope this helps.

[Danl Thompson]

Really, just the javadoc comment? That's too obvious! I can't belive it. I was staring right at it. Thanks.

[Ilja Preuss]

Originally posted by Ibrahim Hashimi:

* @deprecated This method is now deprecated, it has been replaced by myNewMethod(int).

If you wanted to conform to the Sun standard, this should rather look like

* @deprecated since xxx, replaced by myNewMethod(int).