Apa cara terbaik untuk mengomentari kelas yang sudah usang di Jawa?

11

Saya ingin tahu cara terbaik untuk menambahkan komentar untuk mengidentifikasi kelas yang sudah usang di Jawa. Haruskah saya menghapus komentar sebelumnya yang ditambahkan ke bagian atas kelas yang membantu programmer lain untuk mengetahui untuk apa kelas itu, atau haruskah saya menambahkannya di bawah komentar?

java code-quality api comments alculete
sumber

Jawaban:

17

Pendekatan yang disarankan untuk penghentian kelas, metode, atau bidang di Jawa adalah dengan menggunakan @Deprecatedanotasi, yang menjadi tersedia di Java 5, atau @deprecatedtag JavaDoc, yang telah ada sejak Java 1.1. Oracle memiliki dokumen tentang hal-hal spesifik tentang bagaimana dan kapan akan mencabut API yang tampaknya relevan.

Haruskah saya menghapus komentar sebelumnya yang ditambahkan ke bagian atas kelas yang membantu programmer lain untuk mengetahui untuk apa kelas itu atau menambahkannya di bawah komentar?

Anda tidak boleh mengedit atau menghapus komentar yang ada, selain menambahkan tag JavaDoc atau anotasi. Kode usang mungkin masih digunakan dalam sistem warisan, dan pengembang dari sistem tersebut harus memiliki akses ke dokumentasi yang dilakukan pengembang asli dalam beberapa bentuk.

Thomas Owens
sumber
1
+1: Menggunakan anotasi @Depricated juga memberikan kepala ke IDE seperti Eclipse untuk memastikan untuk mencoret metode itu dan memberikan petunjuk visual lainnya kepada pengembang.
Ryan Hayes
ya saya tahu cara menghapus dan menggunakan off annotation pertanyaan saya adalah misalnya saya punya kode ini / ** * komentar tentang kelas ** / kelas publik ClassToDeprecate {// beberapa kode di sini} haruskah saya menghapus komentar dan menjadi seperti ini
alculete
1
@Spammer Artikel yang saya tautkan membahas hal itu. Juga, menjelajah melalui dokumentasi Java API menjawab itu. Satu-satunya hal yang harus Anda lakukan adalah menambahkan @Deprecatedanotasi atau @deprecatedtag JavaDoc. Itu saja - tidak ada yang lain, tidak lebih.
Thomas Owens
Ngomong
1
Menambahkan @deprecatedtag dan deskripsi JavaDoc beserta @Deprecatedanotasi akan memberi lebih banyak penjelasan mengapa itu ditinggalkan. Jadi akan lebih bermanfaat untuk menggunakan keduanya daripada hanya @Deprecatedpenjelasan.
WarFox