redhat-developer / redhat-developer/vscode-java
Feature suggestion: Show warning when javadoc doesn't match the method signature and offer a code action to update it
Đang mở
Chưa có ai nhận issue này.
code action
diagnostics
enhancement
javadoc
- Ngôn ngữ chính
- TypeScript
- Star
- 2.3k
- Fork
- 546
- Merge trung bình
- 20 giờ 1 phút
- Pull request đã merge (30 ngày)
- 11
Mô tả
It’s difficult to remember to update the Javadoc of a method after modifying its signature. It would be practical if the extension could detect this mismatch, show a warning, and propose an update.
Environment
- JDK version: 17
- Visual Studio Code version: v0.29.0
- Java extension version: 1.93.1
Steps To Reproduce
- Generate a java doc for a method
- Add a new argument to the method
Current Result
An outdated javadoc
Expected Result
- Show a warring
- Execute a code action to update the javadoc
- An updated javadoc
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Chưa xác định được tệp, bài kiểm thử hoặc điểm vào nào. Trước tiên, hãy tái hiện sự không khớp bằng JDK 17, VS Code 0.29.0 và Java extension 1.93.1, sau đó tìm các điểm vào diagnostic và code-action của extension. Công việc được xem là hoàn tất khi một lỗi không khớp chữ ký tạo ra cảnh báo và một action cập nhật Javadoc.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- java, typescript, vscode
- Lĩnh vực
- developer-experience, tooling
- Loại issue
- Tính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100