microsoft / microsoft/TypeScript-TmLanguage

JSDoc grammar highlights @return {@link ...} as type

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

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

Ngôn ngữ chính
TypeScript
Star
471
Fork
149
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

With the following code, TS claims that {@link TreeItem} is incorrect

export interface TreeDataProvider<T> {
/**
 * @return {@link TreeItem} representation of the element
*/
 getTreeItem(element: T): TreeItem;
}

adding a character between return and {@link TreeItem} resolves it.

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

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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

Tái hiện việc xử lý không chính xác bằng ví dụ JSDoc trong issue, sau đó kiểm tra các quy tắc ngữ pháp TypeScript TextMate bao quát các thẻ @return và {@link ...} inline. Được xem là hoàn tất khi liên kết không còn bị coi là kiểu không hợp lệ hoặc được tô sáng không chính xác, trong khi các kiểu @return thông thường vẫn hoạt động.

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

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.