Java'da kullanımdan kaldırılmış bir sınıfa yorum yapmanın en iyi yolu nedir?

Java'da kullanımdan kaldırılmış bir sınıfı tanımlamak için bir yorum eklemek için en iyi yolu bilmek istiyorum. Başka bir programcının bu sınıfın ne olduğunu bilmesine yardımcı olan sınıfın en üstüne eklenen önceki yorumu kaldırmalı mıyım yoksa yorumu aşağıya eklemeliyim?

— alculete
kaynak

Java'da bir sınıfı, yöntemi veya alanı kullanımdan kaldırmaya yönelik önerilen yaklaşım, Java 5'te kullanıma sunulan @Deprecatedek açıklamayı veya @deprecatedJava 1.1'den bu yana mevcut olan JavaDoc etiketini kullanmaktır. Oracle, alakalı görünen API'ların nasıl ve ne zaman kullanımdan kaldırılacağına ilişkin ayrıntılar hakkında bir belgeye sahiptir .

Başka bir programcı için o sınıfın ne olduğunu bilmek veya yorumun altına eklemek yardımcı olur sınıfın üstüne eklenen önceki yorumu kaldırmak gerekir?

JavaDoc etiketi veya ek açıklama eklemek dışında mevcut yorumları düzenlememeli veya kaldırmamalısınız. Kullanımdan kaldırılmış kod hala eski sistemlerde kullanılıyor olabilir ve bu sistemlerin geliştiricilerinin orijinal geliştiricilerin bir şekilde yaptıkları belgelere erişmeleri gerekir.

— Thomas Owens
kaynak

+1: @Depricated ek açıklamalarını kullanmak, Eclipse gibi IDE'lere de bu yöntemi aştığından ve geliştiricilere diğer görsel ipuçları verdiğinden emin olmak için bir kafa verir.

— Ryan Hayes

evet nasıl itiraz ve ek açıklama kapalı kullanımı benim sorum örneğin ben bu kod var / ** * sınıf hakkında yorum var ** / public class ClassToDeprecate {// burada bazı kod} yorum kaldırmak ve böyle olması gerekir

— alculete

@ Spammer Bağlantı verdiğim makale bunu tartışıyor. Ayrıca, Java API belgelerine göz atmak da buna cevap verir. Yapmanız gereken tek şey @Deprecatedek açıklama veya @deprecatedJavaDoc etiketini eklemektir . Bu kadar - başka bir şey, başka bir şey.

— Thomas Owens

Bu arada, verdiğiniz bağlantı çok yardımcı oldu

— alculete

Ek @deprecatedaçıklama ile birlikte JavaDoc etiketi ve açıklaması eklemek @Deprecated, neden kullanımdan kaldırıldığına daha fazla ışık tutar. Bu nedenle, @Deprecatedek açıklamadan ziyade her ikisini de kullanmak daha yararlı olacaktır .

— WarFox