microsoft / microsoft/TypeScript

Show documentation for literals in intellisense

Đang mở
#31,769 1 bình luận 5 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Awaiting More Feedback Suggestion
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ả

Suggestion

When filling in a value where the expected type is a union of literals, intellisense is able to suggest the possible values.

However, it does NOT show the documentation associated with each literal:

image

This makes me tend to use enums instead, which has a more verbose syntax and requires an extra import.

Use Cases

Building and documented APIs in typescript will be nicer if we could just document the literals in a union.

Search Terms

  • intellisense for string literals
  • documentation for string literals

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách tái hiện tính năng hoàn tất IntelliSense cho một union gồm các string literal có tài liệu trong TypeScript. Theo dõi hành vi hoàn tất và tài liệu đối với các đề xuất literal, sau đó xác minh rằng mỗi literal được đề xuất đều hiển thị tài liệu liên kết với nó mà không thay đổi hành vi của enum.

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ó
4/5
Thời gian dự kiến
3-5 ngày
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
38/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.