129
Tôi đã xem qua tài liệu javadoc trên trang web của Sun, cố gắng tìm xem có thẻ javadoc nào có thể được sử dụng để ghi lại chữ ký kiểu chung của lớp hoặc phương thức hay không.Có thẻ javadoc để ghi lại các thông số loại chung không?
Giống như @typeparam, tương tự như thông thường @param, nhưng có thể áp dụng cho các loại cũng như phương pháp, 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ể đề cập đến nó ở bất cứ nơi nào và tài liệu API JavaSE không hiển thị bất kỳ dấu hiệu nào, nhưng có vẻ như một sự thiếu sót kỳ lạ. Ai đó có thể đặt tôi đúng không?
Để viết javadocs thích hợp? –
Xin lưu ý rằng đối với * hầu hết * các lớp học thực sự không có gì thú vị khi nói về tham số kiểu, vì tham số kiểu được định nghĩa cơ bản theo cách nó xuất hiện trong các phương thức của đối tượng. Tôi sẽ bỏ qua '@param' 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 đó, cùng áp dụng cho việc sử dụng '@ param' cho các tham số phương thức. Các tiêu chuẩn mã hóa của Sun nói rõ ràng rằng '@ param' nên được sử dụng ngay cả khi ý nghĩa của tham số phương thức là rõ ràng. – skaffman