[Checkstyle] Javadoc parameter alignment check does not work with inlined tags

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#14,405 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
78/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
java
Lĩnh vực
testing

Hướng nghiên cứu

Trong mô-đun checkstyle, kiểm tra kiểm tra JavadocParamAlignment và dữ liệu kiểm thử của nó; issue cung cấp một ví dụ Javadoc tái hiện lỗi và các chẩn đoán cột bị lỗi. Chạy các bài kiểm thử JavadocParamAlignment liên quan, thêm trường hợp này và tìm hiểu lý do văn bản trong các thẻ liên kết ảnh hưởng đến căn chỉnh. Hoàn thành khi trường hợp mới vượt qua cùng với method_multiline_correct.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

type: bug

The custom checkstyle task that enforces param alignment doesn't seem to work with link (and probably other types of) tags.

To reproduce, add the following test case to JavadocParamAlignment in the checkstyle module's test data:

    /**
     * A method that does something
     *
     * @param a                  this is a description
     *                           with a {@link #method(String, String)} link tag
     * @param superLongParamName a description
     *                           blabla
     */
    public void method_multiline_correct_with_link(String a, String superLongParamName) {
    }

and run the tests. I'd expect it to pass just like method_multiline_correct passes, but it currently does not.

Test output:

Violations do not match for src\testData\java\testdata\JavadocParamAlignment.java
Violations not accounted for in test: 
  51:34: Param description for a should start at column 73
  52:34: Param description for a should start at column 73
  53:34: Param description for superLongParamName should start at column 73
  54:34: Param description for superLongParamName should start at column 73
Ngôn ngữ chính
Java
Star
12.8k
Fork
3.6k
Merge trung bình
2 ngày 16 giờ
Pull request đã merge (30 ngày)
40

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của PaperMC/Paper

Tất cả issue của PaperMC/Paper

Issue tương tự

Thêm issue về Java

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.