Consider adding JSDoc-style comments to the examples

Đang mở
  • Có gì không ổn?
#147 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
cpp, nodejs
Lĩnh vực
documentation

Hướng nghiên cứu

After the tutorial site lands, review the current example content and read the linked node-addon-api issue and pull-request comment. Assess the feasibility of JSDoc-style comments and identify the examples that would need review; the issue does not name specific files or define a completion criterion.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

This issue on the node-addon-api repository raises the question of using JSDoc-style comments in C++ code implementing native addons:

https://github.com/nodejs/node-addon-api/issues/758

In addition, @mhdawson has identified another potential benefit of adding JSDoc-style comments to the C++ code:

https://github.com/nodejs/node-addon-api/pull/749#issuecomment-656361110

Once the tutorial site lands, I'd like to do a review of the current content and at that time I can investigate the feasibility of adding JSDoc-style comments to our examples.

Ngôn ngữ chính
C++
Star
2.6k
Fork
598
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

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.

Issue khác của nodejs/node-addon-examples

Tất cả issue của nodejs/node-addon-examples

Issue tương tự

Thêm issue về C++

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.