Consider adding JSDoc-style comments to the examples

オープン
  • 何か問題がありますか？
#147 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
cpp, nodejs
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
C++
スター
2.6k
フォーク
598
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

nodejs/node-addon-examples のほかの issue

nodejs/node-addon-examples の issue をすべて見る

似ている issue

C++ の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。