microsoft / microsoft/TypeScript

Implemented method JSDocs not behaving correctly for @param

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

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

Bug Domain: JSDoc
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ả

TS Template added by @mjbvz

TypeScript Version: 4.0.0-dev.20200518

Search Terms

  • completionEntryDetails
  • jsdoc
  • tags

  • VSCode Version: 1.45.0
  • OS Version: Ubuntu 20.04

Steps to Reproduce:

  1. Add JSDocs to an interface, and implement that interface in a class
interface Sample {
  /** 
   * Does some important work
   * @param name Name of employee working
   * @param age Age of employee
   */
  doWork(name: string, age: number): void;
}

let s: Sample;


class Concrete implements Sample {
  doWork(name: string, age: number) {
    // Nothing to do
  }
}

let c: Concrete;
  1. Attempt to access intellisense for the class, and notice the @param information has not been picked up from the interface.

travetto-1589679889262

Does this issue occur when all extensions are disabled?: Yes

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

Tái hiện ví dụ về interface và lớp triển khai, sau đó kiểm tra đường dẫn completionEntryDetails được IntelliSense sử dụng cho phương thức của lớp. So sánh tài liệu tham số được hiển thị cho interface với tài liệu được hiển thị cho phần triển khai. Được xem là hoàn tất khi các completion của phần triển khai bao gồm các mô tả @param của interface, với phạm vi bao phủ cho ví dụ đã được báo cáo.

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
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.