JavaDoc @see cho hàm tạo MyClass trả lại cảnh báo "không tìm thấy tham chiếu"

Question

Tôi đang cố gắng tạo javadoc cho thư viện ứng dụng khách của mình. Trong MyOtherClass, tôi đặt bên dưới @see và nhận cảnh báo. MyOtherClass và MyClass đều nằm trong các gói khác nhau, trong cùng một dự án.

@see MyClass#Constructor(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyClass#Constructor(Type1 param1, Type2 param2) 

Sau đó, tôi đã cố gắng

@see MyClass#MyClass(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyClass#MyClass(Type1 param1, Type2 param2) 

Cũng cố gắng

@see #MyClass(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyOtherClass#MyClass(Type1 param1, Type2 param2) 

Tôi biết tôi đang thiếu một cái gì đó thật ngớ ngẩn ở đây.

Answer 1

Điều này là do Javadoc cần biết vị trí chính xác của lớp bạn đang tham chiếu để tạo liên kết tới nó. Đơn giản chỉ cần thêm các gói như đã được đề cập trong một bình luận ở trên.

@see mypackage.MyClass#Constructor(Type1 p1, Type2 p2) 

Công cụ javadoc sẽ cho phép bạn có các phím tắt như sau:

// For methods in the same class: 
@see #Constructor(Type1 p1, Type2 p2) 

// For methods in the same package: 
@see MyClass#Constructor(Type1 p1, Type2 p2) 

Nếu bạn có một tên gói dài và muốn ẩn nó, bạn có thể sử dụng một nhãn:

@see mypackage.MyClass#Constructor(Type1 p1, Type2 p2) MyClass#Constructor(Type1 p1, Type2 p2) 

Ở trên sẽ hiển thị:

Xem thêm:MyClass.Constructor(Type1 p1, Type2 p2)

Xem tài liệu Oracle here để biết thêm về @see

---

Cảnh báo: Nếu bạn sử dụng tính năng hoàn thành mã của một số IDE (VD: Eclipse) để tạo các chú thích Javadoc, nó có thể thêm một bản nhập cho gói mà bạn đang tham khảo để thay thế. Trong khi điều này có thể làm cho bình luận của bạn trông sạch hơn bằng cách loại trừ tên gói nó không phải là thực hành tốt để thêm phụ thuộc thực sự hoàn toàn cho tài liệu.