redhat-developer / redhat-developer/vscode-java
Improve readability of javadoc
Chưa có ai nhận issue này.
- 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 would be great if we can read the javado in visual studio editor in an human readable format, instead the code format.
Current Result
Reading documentation in this format is hard.
Expected Result
Having a away to read it in an human readable format, in all objects (files in vscode or referenced through maven or gradel)
Additional Informations
If this already exists, sorry and please let me know.
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
Bắt đầu bằng việc tái tạo cách hiển thị JavaDoc trong trình soạn thảo Visual Studio Code cho các đối tượng Java từ các tệp cục bộ và các dependency được tham chiếu thông qua Maven hoặc Gradle. So sánh kết quả hiện tại được định dạng dưới dạng mã với định dạng dễ đọc đối với con người được yêu cầu, đồng thời xác định phạm vi bao phủ cho tất cả các đối tượng được tham chiếu trước khi xác định entry point của extension và các bài kiểm thử phù hợp.
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, documentation
- 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
- Cần làm rõ
- Mức phù hợp với người mới
- 30/100