11
Tôi không muốn viết nhận xét javadoc thừa. Như bạn có thể thấy, @param x là một cách dư thừa. Có đánh dấu javadoc nào để đặt tham chiếu từ @param x trong lớp B đến @param x trong lớp A hoặc tôi có được phép bỏ qua nó không?Tham số tham chiếu Javadoc từ phương thức khác
/**
* Class A constructor
*
* @param x position on x-axis
*/
public A(final int x) {
this.x = x;
}
/**
* Class B constructor
*
* @param x position on x-axis
* @param y position on y-axis
*/
public B(final int x, final int y) {
super(x);
this.y = y
}
Tôi sẽ lùi lại một bước và hỏi tại sao bạn đang ghi lại các tham số dường như có ý nghĩa rõ ràng. Nếu mã là tự tạo tài liệu dựa trên tên bạn chọn, JavaDoc phần lớn là không liên quan. –
@John Đây là một ví dụ tối thiểu, chỉ để minh họa. – Matthias
Lưu ý cho chính tôi: [{@inheritDoc}] (http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#inheritingcomments) ít nhất là cho phép sao chép tài liệu của một phương pháp ghi đè . – Matthias