Làm cách nào để khai báo hoặc đánh dấu một phương thức Java là không được chấp nhận?

Question

Tôi muốn thực hiện một trong các phương pháp "không được chấp nhận" = không được sử dụng nữa.

Nhưng tôi vẫn muốn có nó trong API của mình. Tôi chỉ muốn hiển thị "cảnh báo" cho bất kỳ ai sử dụng phương pháp đó.

Làm cách nào để đạt được điều đó?

Answer 1

Sử dụng @Deprecated on method. Đừng quên làm rõ lĩnh vực javadoc:

/** 
* Does some thing in old style. 
* 
* @deprecated use {@link #new()} instead. 
*/ 
@Deprecated 
public void old() { 
// ... 
} 

Answer 2

Có hai điều bạn có thể làm:

1. Thêm @Deprecated chú thích để phương pháp, và
2. Thêm một thẻ @deprecated đến javadoc của phương pháp

Bạn nên làm cả hai!

Trích dẫn các java documentation về chủ đề này:

Bắt đầu với J2SE 5.0, bạn không chấp nhận một lớp học, phương pháp, hoặc trường bằng cách sử dụng các chú thích @Deprecated. Ngoài ra, bạn có thể sử dụng thẻ @deprecated Javadoc cho nhà phát triển biết nên sử dụng cái gì để thay thế.

Sử dụng chú thích khiến trình biên dịch Java tạo cảnh báo khi lớp, phương thức hoặc trường không được chấp nhận được sử dụng. Trình biên dịch ngăn chặn cảnh báo không dùng nữa nếu một đơn vị biên dịch không dùng nữa sử dụng lớp, phương thức hoặc trường không được chấp nhận. Điều này cho phép bạn tạo các API cũ mà không tạo cảnh báo.

Bạn nên sử dụng thẻ Javadoc @deprecated với các nhận xét thích hợp giải thích cách sử dụng API mới. Điều này đảm bảo nhà phát triển sẽ có đường dẫn di chuyển khả thi từ API cũ sang API mới

Answer 3

Sử dụng annotation@Deprecated cho phương pháp của bạn, và bạn cũng nên đề cập đến nó trong javadocs của bạn.

Answer 4

Hãy xem chú thích @Deprecated.

Answer 5

Sử dụng cả chú thích @Deprecated và thẻ JavaDoc @deprecated.

Thẻ JavaDoc được sử dụng cho mục đích tài liệu.

Chú thích @Deprecated chỉ thị trình biên dịch là phương pháp không được chấp nhận. Đây là những gì nó nói trong tài liệu Sun/Oracle về đề tài này:

Sử dụng chú thích @Deprecated không chấp một lớp học, phương pháp, hoặc lĩnh vực đảm bảo rằng tất cả các trình biên dịch sẽ phát hành cảnh báo khi mã sử dụng rằng yếu tố chương trình. Ngược lại, không có gì đảm bảo rằng tất cả các trình biên dịch sẽ luôn đưa ra các cảnh báo dựa trên các thẻ Javadoc @deprecated Javadoc, mặc dù các trình biên dịch Sun hiện đang làm như vậy. Các trình biên dịch khác có thể không đưa ra các cảnh báo như vậy.Do đó, việc sử dụng chú thích @Deprecated để tạo cảnh báo có tính di động cao hơn dựa trên thẻ @deprecated Javadoc.

Bạn có thể tìm thấy những tài liệu đầy đủ tại How and When to Deprecate APIs

Answer 6

kể từ khi một số giải thích nhỏ bị mất tích

Sử dụng @Deprecated chú thích vào phương pháp như thế này

/** 
* @param baseprice 
* 
* @deprecated reason this method is deprecated </br> 
*    {will be removed in next version} </br> 
*    use {@link #setPurchasePrice()} instead like this: 
* 
* <blockquote> 
* <pre> 
* getProduct().setPurchasePrice(200) 
* </pre></blockquote> 
* 
*/ 
@Deprecated 
public void setBaseprice(int baseprice) { 
} 

nhớ để giải thích:

• Tại sao phương pháp này không còn khuyến cáo, hãy nhớ đến dòng riêng biệt để có thể đọc </br>
• Khi đó sẽ bị xoá (cho người dùng biết bao nhiêu họ vẫn có thể dựa vào phương pháp này nếu họ quyết định gắn bó với cách cũ)
• Cung cấp một giải pháp hoặc liên kết đến các phương pháp bạn khuyên {@link #setPurchasePrice()}