Consider adding JSDoc-style comments to the examples
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 25/100
- Tipo de issue
- Documentação
- Clareza
- Precisa de esclarecimento
- Status de atividade
- Estagnada
- Stack de tecnologia
- cpp, nodejs
- Domínio
- documentation
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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.
- Linguagem predominante
- C++
- Estrelas
- 2.6k
- Forks
- 598
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de nodejs/node-addon-examples
-
Create Valgrind run of testsAbertaenhancement
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 38/100
nodejs/node-addon-examples#585 · 1 reação ·
-
Add .d.ts files in samples.Aberta
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 38/100
nodejs/node-addon-examples#530 · 1 comentário ·
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 35/100
nodejs/node-addon-examples#445 ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 32/100
nodejs/node-addon-examples#444 · 1 comentário ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 35/100
nodejs/node-addon-examples#381 ·
Todas as issues de nodejs/node-addon-examples
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
cython/cython#8110 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
PR bot doesn't recognize hip-tests as a unit test directoryTalvez já em andamento Um pull request vinculado a esta issue está aberto ou já foi mesclado. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
ROCm/rocm-systems#14923 ·
Mantenedores costumam responder em até 2 dias
-
arrays asr pass bug ICE intrinsic medium priority
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Mantenedores costumam responder em até 1 dia
-
Area: World-Readiness
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
microsoft/calculator#2522 ·
-
missing `catch.hpp`Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
microsoft/inflatelib#34 · 1 comentário ·