Tôi đã xem qua tài liệu javadoc trên trang web của Sun, cố gắng tìm xem liệu có thẻ javadoc có thể được sử dụng để ghi lại chữ ký loại chung của lớp hoặc phương thức không.
Một cái gì đó giống như @typeparam, tương tự như thông thường @param, nhưng áp dụng cho các loại cũng như phương thức, ví dụ
/**
* @typeparam T This describes my type parameter
*/
class MyClass<T> {
}Tôi nghi ngờ không có thẻ như vậy - tôi không thể tìm thấy đề cập đến nó ở bất cứ đâu và các tài liệu API JavaSE không hiển thị bất kỳ dấu hiệu nào của nó, nhưng có vẻ như là một thiếu sót kỳ lạ. Ai đó có thể đặt tôi phải không?
7
Để viết javadocs thích hợp?
—
Timo Willemsen
Xin lưu ý rằng đối với hầu hết các lớp thực sự không có gì thú vị để nói về tham số loại, bởi vì tham số loại về cơ bản được xác định bằng cách nó xuất hiện trong các phương thức của đối tượng. Tôi đã bỏ qua
—
Kevin Bourrillion
@param <T>hầu hết thời gian và chỉ sử dụng nó khi nó thực sự không rõ ràng.
Tôi thấy những gì bạn đang nói, nhưng theo lý do đó, điều tương tự cũng áp dụng cho việc sử dụng các
—
skaffman
@paramtham số phương thức. Các tiêu chuẩn mã hóa của Sun nói rõ ràng rằng @paramnên được sử dụng ngay cả khi ý nghĩa của tham số phương thức là rõ ràng.
Thêm vào đó. Lập trình API tốt nên tự viết tài liệu càng tốt. Điều đó có nghĩa là một api không cần một tài liệu? Không.
—
Timo Willemsen
Các tài liệu hướng dẫn của @ param cho hướng dẫn tham số kiểu. Nhắc bạn, Oracle có thể làm tốt hơn việc quảng cáo tài liệu này.
—
Michael Allan