Есть ли способ предупредить других разработчиков о функции?

Question

Я хочу, чтобы разработчики могли использовать функцию, но я хочу, чтобы они знали, что в большинстве случаев она не предназначена для использования.

Есть ли способ предупредить других разработчиков о функции.Похоже на то, что делает пух.Есть ли что-то вроде @Warning("Prefer using #fooo() if possible) аннотации для метода?Я хочу знать, как это сделать Java или Kotlin.Нечто похожее на @Deprecated, но в моем контексте оно имеет больше смысла.

Я хочу, чтобы моя IDE тоже знала об этом предупреждении, а не только компилятор.

Answer 1

Скажем, у вас есть foo.bar() Создайте делегацию вместо:

foo.special.bar()
foo.special().bar()

Таким способом можно пометить «особого» члена, найти употребления. Требуется рефакторинг.

Это немного похоже на метод получения определенного бизнес-объекта:

foo.getBazBO().bar()

В качестве альтернативы можно использовать собственную аннотацию , использовать Doxygen или какую-либо другую обработку аннотаций, инвестировать усилия в программирование IDE. Больше усилий, меньше немедленных результатов.

Answer 2

К сожалению, я думаю, что это невозможно, но это зависит от используемой вами среды IDE. Не существует встроенного Java-метода, позволяющего методу отображать предупреждение, вы должны внести изменения в анализатор кода IDE, чтобы получить то, что вам нужно.