Який найкращий спосіб коментувати застарілий клас на Java?

Я хотів би знати найкращий спосіб додати коментар для визначення застарілого класу на Java. Чи слід видалити попередній коментар, доданий до початку класу, який допомагає іншому програмісту дізнатися, для чого це клас, або я повинен додати його під коментарем?

— лужник
джерело

Рекомендований підхід до депресирування класу, методу чи поля на Java полягає у використанні @Deprecatedанотації, яка стала доступною в Java 5, або @deprecatedтега JavaDoc, який існує з часу Java 1.1. У Oracle є документ про специфіку того, як і коли знецінювати API, який видається релевантним.

Чи слід видалити попередній коментар, доданий до вершини класу, який допомагає іншому програмісту дізнатися, для чого це клас, або додати його під коментарем?

Не слід редагувати чи видаляти будь-які наявні коментарі, крім того, щоб додати тег JavaDoc або примітку. Стриманий код все ще може використовуватися в застарілих системах, і розробникам цих систем потрібно мати доступ до документації, яку оригінальні розробники робили в якійсь формі.

— Томас Оуенс
джерело

+1: Використання анотацій @Depricated також дає голову до IDE, таких як Eclipse, щоб переконатись у тому, щоб перекреслити цей метод та дати іншим наочним підказкам розробникам.

— Ryan Hayes

так, я знаю, як знехтувати і використовувати анотацію, моє запитання, наприклад, у мене є цей код / ** * коментар про клас ** / публічний клас ClassToDeprecate {// деякий код тут}, чи слід видаляти коментар і бути таким

— alculete

@Spammer Стаття, до якої я посилався, обговорює це. Крім того, перегляд документації Java API відповідає на це. Єдине, що вам слід зробити - це додати @Deprecatedпримітку або @deprecatedтег JavaDoc. Ось це - нічого іншого, більше нічого.

— Томас Оуенс

До речі, посилання, яке ви дали, було дуже корисним

— alculete

Додавання @deprecatedтегу та опису JavaDoc разом із @Deprecatedанотацією дасть більше інформації про те, чому він був застарілим. Тож було б вигідніше використовувати як @Deprecatedанотацію, так і просто .

— WarFox