microsoft / microsoft/TypeScript

Feature Request: Split out JsDoc comments for constructor function when convert function to ES2015 class

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

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

Awaiting More Feedback Domain: LS: Refactorings 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ả

Add ability to convert JsDoc comments in following situation:

/**
 * @class
 * Some constructor description.
 * @classdesc
 * Some class description
 */
function Class() {}

must be converted to

/**
 * Some class description
 */
class Class {
  /**
   * Some constructor description.
   */
  constructor() {}
}

Right now you get following result:

/**
 * @class
 * Some constructor description.
 * @classdesc
 * Some class description
 */
class Class {
  constructor() {}
}

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

Không có tệp, bài kiểm thử hoặc entry point nào được nêu. Hãy bắt đầu bằng cách xác định phần chuyển đổi từ function sang lớp ES2015 và cách xử lý JsDoc của nó; công việc được xem là hoàn tất khi @classdesc trở thành chú thích của lớp, còn phần mô tả constructor trở thành chú thích của constructor, như trong các ví dụ.

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

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.