microsoft / microsoft/TypeScript
Add JSDOC @module support for intellisense.
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Go
- Star
- 111k
- Fork
- 14.4k
- Merge trung bình
- 1 ngày 19 giờ
- Pull request đã merge (30 ngày)
- 117
Mô tả
Search Terms
Intellisense jsdoc support for modules
Suggestion
When adding /** @module moduleName Module Description. */ to a module, then doing this:
import * as myName from "./moduleName";
I think it makes sense, when importing the whole namespace, to include the jsdoc @module comment.
I also think that when pressing Ctrl+Space for code completion on "./" (to get a list of modules) should also show the module documentation.
Use Cases
Better support for module documentation. I'm developing some module libraries and it would be great to give end users a good experience with better intellisense documentation.
Examples
aModule.ts
`/** @module aModule Does something awesome. */`
app.ts
import * as aModule from "./aModule";
// (moduleName should both have the doc details)
// ("./{*.*}" - all files in code completion should show the documentation as well)
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
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 các ví dụ trong aModule.ts và app.ts, sau đó kiểm tra JSDoc hiện có và hành vi hoàn thành module đối với các import namespace và các hoàn thành "./". Được xem là hoàn tất khi tài liệu @module xuất hiện cho namespace đã import và bên cạnh các đề xuất module mà không thay đổi đầu ra khi chạy.
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
- developer-experience, tooling
- 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