-
Notifications
You must be signed in to change notification settings - Fork 13k
Description
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;
*/
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)