Consider adding JSDoc-style comments to the examples
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- cpp, nodejs
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- C++
- Stelle
- 2.6k
- Fork
- 598
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di nodejs/node-addon-examples
-
Create Valgrind run of testsApertaenhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 38/100
nodejs/node-addon-examples#585 · 1 reazione ·
-
Add .d.ts files in samples.Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 38/100
nodejs/node-addon-examples#530 · 1 commento ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
nodejs/node-addon-examples#445 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 32/100
nodejs/node-addon-examples#444 · 1 commento ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
nodejs/node-addon-examples#381 ·
Tutte le issue di nodejs/node-addon-examples
Issue simili
-
`BLMPOP` with COUNT 0 or numkeys 0 hangsForse già presa @ggyuchive l’ha presa oggi. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
needs triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
gObjectFullbrightAlphaMaskProgram in newview/llviewershadermgr.cpp is defined but never initializedApertabug triage
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 78/100
secondlife/viewer#6620 ·
I maintainer di solito rispondono entro 1 giorno
-
bug core p3
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
RunanywhereAI/runanywhere-sdks#1258 ·
I maintainer di solito rispondono entro 1 giorno
-
ripwire-router skill: stale language list (15 vs 26 supported; Elixir/PHP/Kotlin wrongly listed as unsupported)Forse già presa @joyful-ii-V-I l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 80/100
redhat-et/ripwire#521 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno