microsoft / microsoft/TypeScript
Allow reporting errors for unresolved @ link jsdoc tags
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ả
Suggestion
🔍 Search Terms
- jsdoc
@link
⭐ Suggestion
Add an option to report unresolved @link symbols in JSDoc comments.
This can help catch some simple mistakes and also alert the user to cases where our IntelliSense doesn't understand the jsdocs symbol
📃 Motivating Example
/**
* {@link food} <- Should been an error here
*/
const foo = 12
💻 Use Cases
We'd use this in vscode for both our main codebase and for our vscode.d.ts file.
I imagine this would also be quite useful for maintaining definitely typed
Related issues
- #15852
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 ví dụ JSDoc làm động lực và issue liên quan #15852 để xác định cách chẩn đoán và cho phép cấu hình các ký hiệu @link chưa được phân giải. Công việc hoàn tất khi một tùy chọn báo cáo các liên kết chưa được phân giải mà không ảnh hưởng đến các liên kết hợp lệ, bao gồm các trường hợp sử dụng VS Code và tệp khai báo được mô tả.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- javascript, typescript
- Lĩnh vực
- compilers
- 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
- 35/100