Consider adding JSDoc-style comments to the examples

Ouverte
#147 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

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
602
Aucune PR mergée en 30 j

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de nodejs/node-addon-examples

Toutes les issues de nodejs/node-addon-examples

Issues similaires

Plus d'issues C++

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.