cuốn sách gpt4 ai đã làm

Phương thức triển khai có nên có chú thích JavaDoc nếu giao diện của nó có chú thích JavaDoc

In lại Tác giả: Taklimakan Thời gian cập nhật: 2023-11-01 22:07:00 36 4
mua khóa gpt4 Nike

Giả sử tôi có một giao diện như sau.

giao diện công cộng MyInterface{

/**
* Phương thức này in ra lời chào
*/
void sayXin chào();

/**
* Phương pháp này in lời tạm biệt
*/
void sayGoodBye();
}

Các lớp cụ thể thực hiện các phương pháp này. Bây giờ, các phương thức trong các lớp cụ thể có cần phải định nghĩa javadoc bên cạnh định nghĩa phương thức của chúng không? Tôi đã thấy một số người chỉ sao chép định nghĩa javadoc tương tự vào phương thức triển khai của một lớp cụ thể. Tôi không nghĩ đây là một cách làm tốt vì nếu muốn thay đổi định nghĩa tài liệu, chúng ta cần thực hiện thay đổi ở nhiều nơi.

Thực hành tiêu chuẩn về vấn đề này là gì?

câu trả lời hay nhất

Bạn có thể sử dụng {@inheritDoc} Để kế thừa tài liệu của một giao diện, chỉ cần thêm các nhận xét bổ sung nếu bạn cho rằng chúng quan trọng và phù hợp với việc triển khai cụ thể.

Chỉ sử dụng @inheritDoc nếu bạn có ý định thêm vào tài liệu giao diện/siêu lớp gốc. Nếu bạn chỉ cần một bản sao, Javadoc sẽ lo việc đó. Nó sẽ thấy rằng tài liệu siêu lớp áp dụng cho các phương thức được ghi đè của lớp con, vì lớp con không cung cấp tài liệu bổ sung.

{@inheritDoc} - Kế thừa (bản sao) tài liệu từ lớp kế thừa "gần nhất" hoặc giao diện có thể triển khai vào nhận xét tài liệu hiện tại tại vị trí của thẻ này. Điều này cho phép bạn viết nhiều nhận xét chung hơn ở cấp cao hơn trên cây kế thừa và viết xung quanh văn bản đã sao chép.

http://docs.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html#@inheritDoc

Về java - Phương thức triển khai có nên có nhận xét JavaDoc không nếu giao diện của nó có nhận xét JavaDoc, chúng tôi đã tìm thấy một câu hỏi tương tự trên Stack Overflow: https://stackoverflow.com/questions/40701608/

36 4 0
Chứng chỉ ICP Bắc Kinh số 000000
Hợp tác quảng cáo: 1813099741@qq.com 6ren.com
Xem sitemap của VNExpress