microsoft / microsoft/TypeScript
JSDoc tags not parsed when a type may be present
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ả
### 🔎 Search Terms
jsdoc links missing in possible type position
### 🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about JSDoc
### ⏯ Playground Link
https://www.typescriptlang.org/play/?#code/MYGwhgzhAEDC0G8BQBfJB6AVJp1PQAEAXACwCcB7AdxgQJAEsA7AazjT3SQDMBXJ4EQYUm0LJnSxYACgCUiVEA
### 💻 Code
```ts
class C {
}
/**
* @throws {@link C}
*/
function /**/CC() {
}
```
### 🙁 Actual behavior
TypeScript does not resolve `{@link C}`.
Hover on the playground shows:
```
@throws — {
@link — C}
```
### 🙂 Expected behavior
TypeScript should resolve `{@link C}`
Hover on the playground should show this (or even better rendered links like it does in vscode)
```
@throws — {@link C }
```
### Additional information about the issue
Originally reported in https://github.com/TypeStrong/typedoc/issues/2993
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
Bắt đầu với liên kết TypeScript Playground được cung cấp và ví dụ JSDoc chứa `@throws {@link C}`. Theo dõi cách các thẻ JSDoc được phân tích cú pháp khi có thể có một kiểu; hoàn thành khi liên kết được phân giải thành `C` và phần hover trong Playground hiển thị nội dung liên kết thay vì tách `@link` khỏi `C`.
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
- compilers
- 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
- 45/100