كيف تعلن أو تضع علامة على طريقة Java كمهمل؟




deprecated (4)

أود أن أجعل إحدى طرقي "موقوفة" = لم تعد مستخدمة.

ولكن ما زلت أود أن يكون ذلك في بلدي API. أريد فقط إظهار "تحذير" لأي شخص يستخدم هذه الطريقة.

كيف يمكنني تحقيق ذلك؟


ألقِ نظرة على التعليقات التوضيحية @Deprecated .


استخدم annotation @Deprecated الخاصة بك ، ويجب عليك أيضًا ذكرها في javadocs.


استخدمDeprecated على الطريقة. لا تنسَ توضيح حقل javadoc:

/**
 * Does some thing in old style.
 *
 * @deprecated use {@link #new()} instead.  
 */
@Deprecated
public void old() {
// ...
}

لأن بعض التفسيرات الطفيفة كانت مفقودة

استخدم @Deprecated على طريقة مثل هذه

/**
 * @param baseprice
 * 
 * @deprecated  reason this method is deprecated </br>
 *              {will be removed in next version} </br>
 *              use {@link #setPurchasePrice()} instead like this: 
 * 
 * <blockquote>
 * <pre>
 * getProduct().setPurchasePrice(200) 
 * </pre></blockquote>
 * 
 */
@Deprecated
public void setBaseprice(int baseprice) {
}

تذكر أن تشرح:

  • لماذا لم تعد هذه الطريقة موصى بها ، تذكر أن تفصل الخط عن إمكانية القراءة </br>
  • عندما تتم إزالته (دع المستخدمين يعرفون كم يمكنهم الاستمرار في الاعتماد على هذه الطريقة إذا قرروا الالتزام بالطريقة القديمة)
  • تقديم حل أو رابط للطريقة التي توصي بها {@link #setPurchasePrice()}






deprecated