microsoft / microsoft/TypeScript
Allow folding of JSDoc comments
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ả
VsCode version: 1.40.2 (Oct 2019, 2)
OS: Windows 10 v1709 os build 16299.847
TypeScript Version: 3.6.3
Search Terms: vs code fold "app.get" outlining jsdoc comment expressjs folding
Code
/**
* @api {get} /ProjectsList/:projectId/ Get project
*
* @apiDescription Get a project by projectId.
*
* @apiName Get User Projects
* @apiGroup Project
* @apiVersion 1.0.0
*
*/
app.get('/:retailUnit/:language/ProjectsList/:projectId/', retailUnit, (req, res) => {
const projectListController = new ProjectListController();
});
Repro:
- Create file foobar.js, copy paste the code from above.
- Try fold all.
Expected behavior: Comment and method fold
Actual behavior: method fold, comment does not
Expected behavior: I can fold the jsdoc comment above the app.get function
Actual behavior: I cannot fold the jsdoc comment, outlining not available.
Related Issues: Some (incorrectly?) for vs code, but these are the ones I found, but the first one is very similar to this one, but for arrow functions instead:
- https://github.com/microsoft/TypeScript/issues/26014
- https://github.com/Microsoft/vscode/issues/55249
- https://github.com/microsoft/vscode/issues/80186
This is my first report here, I hope it is ok. :-)
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 đề trong foobar.js bằng JSDoc và ví dụ app.get được cung cấp, sau đó truy vết hành vi outlining của TypeScript/VS Code. Được xem là hoàn tất khi Fold All và điều khiển thu gọn của comment bao gồm khối JSDoc; báo cáo không nêu file nguồn hay test cụ thể nà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ệ
- javascript, typescript, vscode
- Lĩnh vực
- tooling
- 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
- 30/100