Consider adding JSDoc-style comments to the examples
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- À l'abandon
- Stack technique
- cpp, nodejs
- Domaine
- documentation
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- C++
- Étoiles
- 2.6k
- Forks
- 598
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de nodejs/node-addon-examples
-
Create Valgrind run of testsOuverteenhancement
Difficulté 4/5 3-5 jours Accessibilité débutants 38/100
nodejs/node-addon-examples#585 · 1 réaction ·
-
Add .d.ts files in samples.Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 38/100
nodejs/node-addon-examples#530 · 1 commentaire ·
-
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
nodejs/node-addon-examples#445 ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 32/100
nodejs/node-addon-examples#444 · 1 commentaire ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
nodejs/node-addon-examples#381 ·
Toutes les issues de nodejs/node-addon-examples
Issues similaires
-
documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
EchoTools/nevr-runtime#2042 ·
Les mainteneurs répondent en général sous 1 jour
-
Download size and speed show scientific notation between 1000 and 1023 unitsPeut-être pris @RaphaelFakhri l’a pris aujourd’hui. Ouverte
Difficulté 2/5 Moins d'une heure Accessibilité débutants 88/100
kiwix/kiwix-desktop#1570 ·
Les mainteneurs répondent en général sous 1 jour
-
Device Request
Difficulté 2/5 Une demi-journée Accessibilité débutants 62/100
dresden-elektronik/deconz-rest-plugin#8686 ·
Les mainteneurs répondent en général sous 1 jour
-
nixos/noctalia-greeter: greeter finds no sessions (session dirs not passed via XDG_DATA_DIRS)Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
aminya/project_options#303 ·