Nhận xét Javadoc dành cho các nhà xây dựng đơn giản. Cần thiết hoặc không cần thiết?

Question

Với đoạn mã sau:

/** 
* Initializes a new instance. 
* 
*/ 
public Collector() { 
    this.map = new HashMap<>(); 
} 

hãy tập trung vào các Javadoc bình luận: Có không xảy ra rất nhiều trong constructor này. Vậy, cách thích hợp để viết Javadoc cho nó là gì? Như được hiển thị ở trên? Điều đó sẽ hoàn toàn chính xác nhưng dư thừa cùng một lúc, bởi vì một hàm tạo có nghĩa là khởi tạo một cá thể mới.

Vì vậy, một mặt, chúng tôi không muốn viết thông tin dư thừa trong các nhận xét của Javadoc, mặt khác, phải có một chú thích Javadoc (có nó?).

Vì vậy, trong ngắn hạn, làm thế nào để viết ý nghĩa, không dư thừa Javadoc trong các tình huống như vậy?

Answer 1

Tùy thuộc vào ai là người đọc mã và chức năng của hàm tạo là rõ ràng như thế nào. Hoặc javadoc là nguồn thông tin duy nhất cho người đọc (nguồn đóng), hoặc người đọc có thể dễ dàng nắm bắt những gì đang diễn ra chi tiết từ nguồn. Trong các dự án của chúng tôi, chúng tôi không thực hiện chức năng rõ ràng của javadoc. Khi một số hình thức đòi hỏi javadoc, chúng ta chỉ cần sử dụng/** Constructor. */chỉ để thỏa mãn hình thức.