Jak oznaczyć prywatne metody java używane w przestarzałym API - java, styl kodowania

Jak oznaczyć prywatne metody Java używane w przestarzałym interfejsie API, aby było jasne, że istnieją one tylko dlatego, że przestarzały interfejs API nie został usunięty i nie należy go używać w nowym interfejsie API?

lubię to

@Deprecated
public void doSomething() {
List<String> list = new ArrayList<>();
list.addAll(returnList());
}

private List<String> returnList() {
return new ArrayList<>();
}

Myślałem o dodaniu

//TODO remove this after #deprecatedMethod is removed

Ale nie jestem pewien, czy to jest dokładne

Odpowiedzi:

Aby oznaczyć metody, których nie należy używać, można zadeklarować metody jako @Deprecated, aby dodać komentarze, najlepsze praktyki zostały wyjaśnione w javadoc pole. Proponuję również stworzyć nowe metody i połączyć je w javadoc, aby uniknąć przyszłych problemów:

/**
* This method use a deprecated API
*
* @deprecated use {@link #newMethodNodeprecated()} instead.
*/
@Deprecated
public void oldMethod() {
// ...
}

ZA private metoda nigdy nie jest ujawniana w interfejsie API, więc nie powinno być powodu, aby je oznaczać, ponieważ użytkownik interfejsu API nie będzie o nich wiedział.

Ponadto, jeśli używasz dowolnego IDE, nieużywana metoda prywatna zostanie podświetlona jako method is never used.