Tôi muốn biết cách tốt nhất để thêm một nhận xét để xác định một lớp không dùng nữa trong Java. Tôi có nên xóa nhận xét trước đó được thêm vào đầu lớp để giúp một lập trình viên khác biết lớp đó dùng để làm gì, hay tôi nên thêm nó vào bên dưới bình luận?
Câu trả lời:
Cách tiếp cận được đề xuất để loại bỏ một lớp, phương thức hoặc trường trong Java là sử dụng @Deprecatedchú thích, có sẵn trong Java 5 hoặc @deprecatedthẻ JavaDoc, xuất hiện từ Java 1.1. Oracle có một tài liệu về các chi tiết cụ thể về cách thức và thời điểm loại bỏ các API dường như có liên quan.
Tôi có nên xóa bình luận trước đó được thêm vào đầu lớp để giúp một lập trình viên khác biết lớp đó để làm gì hoặc thêm nó vào bên dưới bình luận không?
Bạn không nên chỉnh sửa hoặc xóa bất kỳ nhận xét hiện có nào, ngoài việc thêm thẻ JavaDoc hoặc chú thích. Mã không dùng nữa có thể vẫn được sử dụng trong các hệ thống cũ và các nhà phát triển của các hệ thống đó cần có quyền truy cập vào tài liệu mà các nhà phát triển ban đầu đã thực hiện dưới một hình thức nào đó.
@Deprecatedchú thích hoặc @deprecatedthẻ JavaDoc. Đó là nó - không có gì khác, không có gì hơn.
@deprecatedthẻ JavaDoc và mô tả cùng với @Deprecatedchú thích sẽ cung cấp thêm ánh sáng về lý do tại sao nó bị phản đối. Vì vậy, sẽ có lợi hơn khi sử dụng cả hai thay vì chỉ @Deprecatedchú thích.