microsoft / microsoft/TypeScript

Intellisense should inherit documentation for Interfaces.

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

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

Experience Enhancement 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ả

When implementing an interface the intellisense feature is capable of detecting the description of the interface however it does not carry over any tags such as @param and @returns.

Below is a picture of an example:

image

You can see that the description is properly shown however the param and returns tag is not.
What is expected:

image

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 hành vi IntelliSense đã được báo cáo với một interface chứa tài liệu và các thẻ @param/@returns, sau đó kiểm tra đường dẫn dịch vụ ngôn ngữ TypeScript cung cấp tài liệu cho các thành viên interface được triển khai. Hoàn tất khi thành viên triển khai hiển thị mô tả interface cùng với các thẻ tham số và giá trị trả về được kế thừa.

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
Loại issue
Lỗi
Độ khó
3/5
Thời gian dự kiến
1-2 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
35/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.