reactjs / reactjs/react.dev

Add samples) react components with JSDocs!

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

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

Ngôn ngữ chính
JavaScript
Star
11.8k
Fork
7.9k
Merge trung bình
1 ngày 11 giờ
Pull request đã merge (30 ngày)
11

Mô tả

jsdoc-comment

Please add samples on JSDocs with react, a lot programmers including me need IntelliSense and other benefits like auto-completion and type-checking as well. Migration over to TypeScript is not ideal if you have large code base. Adding a JSDoc comment is the easiest way of getting a lot of TypeScript tooling without configuring any code at all. On top of that vscode already supports it just by turning on in the settings
"javascript.implicitProjectConfig.checkJs": true

It even provides comment template for JavaScript functions when you type/**
jsdoc-autofill

That's way I think reactjs docs should provide examples on this

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 hoặc bài kiểm thử nào được nêu tên; hãy bắt đầu bằng cách xem xét các ví dụ hiện có trong tài liệu React cùng với ngữ cảnh JSDoc và VS Code của yêu cầu. Xác định những ví dụ nào nên minh họa JSDoc, sau đó kiểm tra để bảo đảm tài liệu có các mẫu có thể sử dụng, giải thích những lợi ích dự kiến của IntelliSense, tính năng hoàn tất và kiểm tra kiểu.

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, react
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
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.