Chi tiết về sự khác biệt giữa @see và @inheritDoc

Question 1

Tôi đã xem qua tham chiếu JavaDoc và trong khi tôi hiểu sự khác biệt cơ bản giữa @see(các liên kết khác nhau) và {@inheritDoc}(xuất nhận xét JavaDoc siêu lớp), tôi cần làm rõ cách mọi thứ thực sự được triển khai.

Trong IDE Eclipse khi tôi chọn “Tạo chú thích phần tử” cho phương thức kế thừa (từ giao diện hoặc ghi đè toString (), v.v.), nó sẽ tạo nhận xét sau

/* (non-Javadoc)
 * @see SomeClass#someMethod()
 */

Nếu tôi được yêu cầu sản xuất JavaDoc, tôi có nên để nó ở đó, thay thế @seebằng {@inheritDoc}hoặc chuyển nó thành JavaDoc hoàn hảo như sau:

/**
 * {@inheritDoc}
 */

Và khi tôi làm điều đó, tôi có nên giữ cờ phương thức lớp # không?

Question 2

Trước hết, bạn nên xóa mẫu nhật thực ban đầu vì nó chỉ là rác ồn ào. Đặt tài liệu có ý nghĩa vào hoặc không đặt bất kỳ thứ gì. Nhưng việc tái tạo lại những thứ hiển nhiên vô ích bằng cách sử dụng các mẫu IDE chỉ làm xáo trộn mã.

Thứ hai, nếu bạn bắt buộc phải sản xuất javadoc, thì bạn phải bắt đầu nhận xét /**. Nếu không, nó không phải là javadoc.

Cuối cùng, nếu bạn đang ghi đè thì bạn nên sử dụng @inheritDoc(giả sử bạn muốn thêm vào tài liệu gốc, như @seh đã lưu ý trong nhận xét, nếu bạn chỉ muốn sao chép tài liệu gốc thì bạn không cần bất cứ thứ gì). @seechỉ nên thực sự được sử dụng để tham khảo các phương pháp liên quan khác.