microsoft / microsoft/TypeScript
Support JSDoc `@function`
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ả
From: https://github.com/Microsoft/vscode/issues/21321
TypeScript Version: 2.2.1 / nightly (2.2.0-dev.201xxxxx)
Code
// test-module.d.ts
declare module 'test-module' {
declare function func<T>(c: T): (y: any) => any;
}
// example.js
import { func } from 'test-module';
/**
* @function
* @param {number} c first number
* @returns {number} result
*/
const thisDoesNot = func(1);
Expected behavior:
The JSDoc specifications give thisDoesNot a type of (c: number) => number
Actual behavior:
The type from the *.d.ts file is preferred instead, giving thisDoesNot a type of (c: any) => any
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
Tái hiện vấn đề bằng các snippet test-module.d.ts và example.js được cung cấp, sau đó lần theo cách TypeScript xử lý JSDoc @function và cách các kiểu khai báo được import được lựa chọn. Công việc được xem là hoàn tất khi các chú thích JSDoc tạo ra (c: number) => number cho thisDoesNot mà không gây hồi quy trong việc định kiểu tệp khai báo thông thườ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ệ
- 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