microsoft / microsoft/TypeScript
Display operator informaton on mouse-over
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Go
- Star
- 111k
- Fork
- 14.4k
- Merge trung bình
- 1 ngày 19 giờ
- Pull request đã merge (30 ngày)
- 117
Mô tả
Search Terms
operator information definition mouse over hover preview tool-tip
Suggestion
Show a tooltip when hovering over operators like +=, %or ===. The tooltip should explain the operator.
I was told in https://github.com/microsoft/vscode/issues/107046 to apply here.
Use Cases
As a beginner developer, I usually download foreign code to help me understand implementations. Often the more experienced developers use operators I do not know. It would be very helpful if the IDE could show me a short definition of that operator when I hover my mouse over it, similar to how it tells me what a function does. Ideally it also tells me how the operator is called and gives a link to some online documentation.
Examples
When I have code like var x = condition ? 12 : (int?)null; I can hover over ? or : and it shows tool-tip like "Ternary operator: is this condition true ? yes : no".
Or a more simple example: What does x += y do? Hover: "Addition assignment: x = x + y".
Checklist
My suggestion meets these guidelines:
- [ x] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [ x] This wouldn't change the runtime behavior of existing JavaScript code
- [ x] This could be implemented without emitting different JS based on the types of the expressions
- [ x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- [ x] This feature would agree with the rest of TypeScript's Design Goals.
(To be perfectly honest, I don't really understand all of the above, but I'm guessing yes..)
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 hành vi hover được yêu cầu đối với các toán tử và issue VS Code được liên kết. Không có tệp triển khai, bài kiểm thử hoặc điểm vào nào được nêu, vì vậy nhiệm vụ đầu tiên là xác định khu vực liên quan của dịch vụ ngôn ngữ TypeScript. Công việc được xem là hoàn tất khi hover trên các toán tử được hỗ trợ hiển thị phần giải thích ngắn, hướng dẫn sử dụng và lý tưởng nhất là các liên kết đến tài liệu.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- javascript, typescript
- Lĩnh vực
- developer-experience, 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
- Khá rõ ràng
- Mức phù hợp với người mới
- 25/100