Javadoc @see hoặc {@link}?

Question

Ai đó có thể cho tôi biết sự khác biệt giữa javadoc @see và {@link}?

Hay đúng hơn, khi nào nên sử dụng cái nào trong số đó?

Answer 1

Số official guidelines về điều này khá rõ ràng.

Sự khác biệt chức năng bao gồm:

• {@link} là một liên kết nội tuyến và có thể được đặt bất cứ nơi nào bạn thích
• @see tạo ra phần riêng của nó

Theo tôi, {@link} là tốt nhất được sử dụng khi nghĩa là bạn sử dụng tên lớp, trường, hàm tạo hoặc tên phương thức trong mô tả của mình. Người dùng sẽ có thể nhấp qua javadoc của những gì bạn đã liên kết.

tôi sử dụng @see chú thích trong 2 trường hợp:

• Something là rất phù hợp nhưng không được đề cập trong mô tả.
• Tôi đề cập đến cùng một điều nhiều lần trong mô tả và được sử dụng để thay thế cho nhiều liên kết giống nhau.

Tôi dựa trên ý kiến ​​này về việc kiểm tra ngẫu nhiên tài liệu về nhiều thứ khác nhau trong thư viện chuẩn.

Answer 2

@see tạo một dòng riêng biệt trong Javadocs. {@link} là để nhúng trong văn bản.

Tôi sử dụng @see khi là một thực thể có liên quan nhưng tôi không đề cập đến nó trong văn bản quảng cáo. Tôi sử dụng liên kết bên trong văn bản khi có khớp nối chặt chẽ hoặc (tôi cảm thấy) có khả năng người đọc sẽ hưởng lợi từ gợi ý điều hướng, ví dụ: bạn sẽ cần tham chiếu trực tiếp.