Jak zadeklarować lub oznaczyć metodę Java jako nieaktualną?

Question

Chciałbym, aby jedna z moich metod była "przestarzała" = nie była już używana.

Ale nadal chciałbym mieć to w moim API. Chcę tylko pokazać "ostrzeżenie" każdemu, kto używa tej metody.

Jak mogę to osiągnąć?

Answer 1

Użyj metody @Deprecated na metodzie. Nie zapomnij o wyjaśnienie pole javadoc:

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

Answer 2

Są dwie rzeczy, które możesz zrobić:

1. Dodaj @Deprecated adnotacji do sposobu i
2. Dodaj @deprecated tag do javadoc metody

Należy zrobić zarówno!

Cytowanie java documentation na ten temat:

Począwszy J2SE 5.0, ty potępiać do klasy, metody lub pola za pomocą adnotacji @Deprecated. Ponadto można użyć znacznika @adaptowany Javadoc, aby programiści mogli się z tego dowiedzieć.

Użycie adnotacji powoduje, że kompilator Java generuje ostrzeżenia, gdy używana jest nieaktualna klasa, metoda lub pole. Kompilator pomija ostrzeżenia o wycofaniu, jeśli wycofana kompilacja używa wycofanej klasy, metody lub pola. Umożliwia to tworzenie starszych API bez generowania ostrzeżeń.

Zdecydowanie zaleca się używanie znacznika Javadoc @deprecated z odpowiednimi komentarzami wyjaśniającymi, jak korzystać z nowego interfejsu API. Dzięki temu programiści będą mieli sprawną ścieżkę migracji ze starego interfejsu API do nowego interfejsu API

Answer 3

Użyj annotation@Deprecated do sposobu i należy również wspomnieć o tym w swoim Javadocs.

Answer 4

Spójrz na adnotację @Deprecated.

Answer 5

Użyj zarówno adnotacji @Deprecated, jak i znacznika JavaDoc @deprecated.

Tag JavaDoc służy do celów dokumentacyjnych.

Adnotacja @Deprecated instruuje kompilator, że metoda jest przestarzała. Oto, co mówi się w dokumencie Słońce/wyrocznie na temat:

Używanie @Deprecated adnotacji do potępiać klasę, metody lub pola zapewnia, że ​​wszystkie kompilatory będą wydawać ostrzeżenia, gdy kod używa tego elementu programu. W przeciwieństwie do tego nie ma gwarancji, że wszystkie kompilatory będą zawsze wydawały ostrzeżenia w oparciu o znacznik Javadoc, choć kompilacje firmy Sun obecnie to robią. Inne kompilatory mogą nie wysyłać takich ostrzeżeń.Tak więc użycie komentarza do generowania ostrzeżeń jest bardziej przenośne niż użycie znacznika Javadoc.

można znaleźć pełny dokument w How and When to Deprecate APIs

Answer 6

ponieważ pewne drobne wyjaśnienia brakowało

Korzystając @Deprecated adnotacji o sposobie jak ten

/** 
* @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) { 
} 

pamiętać, aby wyjaśnić:

• Dlaczego ta metoda nie jest już zalecane, Pamiętaj, aby linia oddzielne dla czytelności </br>
• Kiedy zostanie on usunięty (niech użytkownicy wiedzą, ile mogą nadal powoływać się na tę metodę, jeśli postanowili trzymać się starej drodze)
• stanowić rozwiązanie lub link do metody polecacie {@link #setPurchasePrice()}