microsoft / microsoft/TypeScript

Hover documentation for typescript uses jsdoc rules and not tsdoc

Đang mở
#61,603 8 bình luận 5 reaction 0 người được giao Xem trên GitHub
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ả

- VS Code Version: 1.99.3
17baf841131aa23349f217ca7c570c76ee87b957
x64
- OS Version: N/A (happens on all)

Steps to Reproduce:

1. Write some typescript code and use the syntax required by tsdoc
2. Observe that hover documentation and highlighting completely ignore tsdoc and instead assume parity with jsdoc
3. Cry in pain as you realize that despite being written in typescript, VSCode has shoddy typescript support

Examples:

Thinking that the [mandatory hyphen](https://tsdoc.org/pages/tags/param/) after a parameter name is a markdown hint for a bullet point
![Image](https://github.com/user-attachments/assets/bbe5ae33-38e6-42dc-a00e-98e163313c33)

Not recognizing the `@defaultValue` tag, and assuming `@default` and `@defaultvalue`

![Image](https://github.com/user-attachments/assets/9c34bfaf-e412-429b-9d27-6ee7b7c19107)

Not understanding [`@remarks`](https://tsdoc.org/pages/tags/remarks/), which is marked as [core](https://tsdoc.org/pages/spec/standardization_groups/), meaning you are expected to recognize it

Not providing hover for `@typeParam`
 ![Image](https://github.com/user-attachments/assets/82c94ee5-44a5-47fb-a7c6-e42740205fd0)

(The list goes on...)

Also, this last remark isn't a bug, but it would be really, _really_ great if you would support [`@inheritDoc`](https://tsdoc.org/pages/tags/inheritdoc/) for hover.

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

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

Hướng nghiên cứu

Bắt đầu bằng cách tái hiện các ví dụ TSDoc được liệt kê trong VS Code 1.99.3, so sánh văn bản hover và phần tô sáng với các quy tắc TSDoc được liên kết. Truy vết đường dẫn tài liệu hover của TypeScript xử lý các thẻ JSDoc, sau đó xác minh rằng các thẻ cốt lõi như @param, @defaultValue, @remarks và @typeParam được nhận diện với định dạng mong đợi.

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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
48/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.