phong cách; đặt javadoc trước hay sau chú thích?

Tôi biết rằng đó không phải là vấn đề quan trọng nhất, nhưng tôi chỉ nhận ra rằng tôi có thể đặt khối nhận xét javadoc trước hoặc sau chú thích. Điều gì chúng ta muốn áp dụng như là một tiêu chuẩn mã hóa?

/**
 * This is a javadoc comment before the annotation 
 */
@Component
public class MyClass {

    @Autowired
    /**
     * This is a javadoc comment after the annotation
     */
    private MyOtherClass other;
}

Trước chú thích, vì chú thích là mã "thuộc về" lớp. Xem ví dụ với javadoc trong tài liệu chính thức.

Đây là ví dụ ngẫu nhiên tôi tìm thấy trong một trang Java chính thức khác :

/**
 * Delete multiple items from the list.
 *
 * @deprecated  Not for public use.
 *    This method is expected to be retained only as a package
 *    private method.  Replaced by
 *    {@link #remove(int)} and {@link #removeAll()}
 */
@Deprecated public synchronized void delItems(int start, int end) {
    ...
}

Tôi đồng ý với câu trả lời đã được đưa ra.

Chú thích là một phần của mã trong khi javadoc là một phần của tài liệu (do đó là tên).

Vì vậy, đối với tôi nó có đường may hợp lý để giữ các phần mã với nhau.

Tất cả đi xuống để sẵn sàng. Theo ý kiến ​​của tôi, mã dễ đọc hơn với Chú thích ngay phía trên phương thức / trường.

Ngoài tiêu chuẩn mã hóa, có vẻ như công cụ javadoc không xử lý các bình luận javadoc nếu chúng được đặt sau các chú thích. Hoạt động tốt khác.

Tôi đồng ý với tất cả những điều trên. Có thể hữu ích cho những người khác rằng các mẫu kiểu mã của IntelliJ (Idea) thất bại cả về mặt tích cực giả (khi @throws được chỉ định chính xác, nó cảnh báo) và âm tính giả (khi @throws không được chỉ định, nhưng nên được) khi sử dụng kiểu Rest EAS chú thích. Tôi đặt javadocs của tôi lên trên mọi thứ khác, sau đó chú thích, sau đó viết mã.

Xem báo cáo lỗi tại đây: https://youtrack.jetbrains.com/su/IDEA-220520