getappmap / getappmap/appmap-java
Enrich sequence diagram with JavaDoc comments
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Java
- Star
- 88
- Fork
- 17
- Merge trung bình
- 2 ngày 2 giờ
- Pull request đã merge (30 ngày)
- 1
Mô tả
It would be useful to have more context for methods and call points in sequence diagrams. This would allow them to be demonstrated to analysts, customers and the product owner - people who do not have programming skills, but understand natural language.
In the past, I've made diagrams like this using my aspect-based instrumentation code and comment extractor from Java project sources.
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 xem xét Java agent này tạo ra các sơ đồ tuần tự như thế nào và ngữ cảnh của phương thức hoặc điểm gọi được biểu diễn ra sao. So sánh việc trích xuất JavaDoc được yêu cầu với dự án extract-javadoc được liên kết và phương pháp instrument dựa trên aspect của tác giả; công việc được coi là hoàn tất khi các sơ đồ tuần tự hiển thị ngữ cảnh phương thức hữu ích bằng ngôn ngữ tự nhiên cho những người không phải lập trình viên.
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
- Lĩnh vực
- tooling
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- 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
- 35/100