Consider adding JSDoc-style comments to the examples
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 文件
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- cpp, nodejs
研究方向
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.
由索引模型根據 Issue 內容生成。
描述
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.
- 主要語言
- C++
- 星號
- 2.6k
- 分支
- 598
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
nodejs/node-addon-examples 的其他 Issue
-
enhancement
難度 4/5 3-5 天 新手友好度 38/100
nodejs/node-addon-examples#585 · 1 個 reaction ·
-
難度 3/5 1-2 天 新手友好度 38/100
nodejs/node-addon-examples#530 · 1 則留言 ·
-
難度 4/5 3-5 天 新手友好度 35/100
nodejs/node-addon-examples#445 ·
-
難度 3/5 1-2 天 新手友好度 32/100
nodejs/node-addon-examples#444 · 1 則留言 ·
-
難度 3/5 1-2 天 新手友好度 35/100
nodejs/node-addon-examples#381 ·
查看 nodejs/node-addon-examples 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 72/100
維護者通常 1 天內回覆
-
bug needs-triage
難度 2/5 1-3 小時 新手友好度 68/100
microsoft/microsoft-ui-xaml#12515 · 1 則留言 · 1 個 reaction ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 66/100
FujiNetWIFI/fujinet-firmware#2261 ·
維護者通常 1 天內回覆
-
bug difficulty: easy good first issue help wanted
難度 2/5 1-3 小時 新手友好度 78/100
nagisa-kamishiro/rosehip#73 ·
維護者通常 1 天內回覆
-
bazel bug odb
難度 1/5 1 小時以內 新手友好度 80/100
The-OpenROAD-Project/OpenROAD#12095 · 1 則留言 ·
維護者通常 1 天內回覆