Consider adding JSDoc-style comments to the examples

Abierto
#147 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
cpp, nodejs
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
C++
Estrellas
2.6k
Forks
602
Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de nodejs/node-addon-examples

Todos los issues de nodejs/node-addon-examples

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.