microsoft / microsoft/TypeScript
Enums and interfaces do not have definitions in quick info/tooltips
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Go
- Star
- 111k
- Fork
- 14.3k
- Merge trung bình
- 2 ngày 4 giờ
- Pull request đã merge (30 ngày)
- 132
Mô tả
The issue might be related to this one, but mine is not about version 3.0, and is not solely about imports.
Search Terms
enum, description, definition, pop-up, tooltip, vs code, interface, suggestion
Suggestion
Hovering over enums and interfaces, should show their definition, i.e. I have this enum (or an interface):
enum enumName {
ONE = 1;
TWO = 2;
THREE = 3;
}
If I hover over this enum, wherever I use it (whether it is imported to another file or used locally where it is declared), I would like to see what this enum is all about (essentially what are the properties).
This is what I see right now when I hover over enums or interfaces:


As a workaround, I currently need to add this type of JSDoc comments right above the enum declaration.
/** Props:
* @param ONE 1;
* @param TWO 2;
* @param THREE 3;
*/
Which yields to:

Use Cases
This feature would save time & effort.
The shortcoming of the current approach is that either need to add ${2+numberOfEnumProperties} lines of comments or go to the file, where enum is declared, locate the enum there and then familiarize myself with its properties.
Examples

Checklist
I am not that experienced to be able to answer the questions below.
- This wouldn't be a breaking change in existing TypeScript / JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. new expression-level syntax)
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
Tái hiện hành vi quick-info đã được báo cáo bằng các ví dụ enum và interface trong issue, cả cục bộ lẫn khi được import. Bắt đầu bằng cách lần theo điểm vào quick-info/tooltip của TypeScript, sau đó xác định hành vi hiển thị hiện có cho các khai báo này. Được xem là hoàn tất khi thao tác di chuột qua hiển thị các định nghĩa và thành viên của chúng trong cả trường hợp sử dụng cục bộ và sử dụng qua import, đồng thời các bài kiểm thử liên quan đã được cập nhật.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- 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
- 35/100