Add samples) react components with JSDocs!
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 11.8k
- フォーク
- 7.9k
- 平均マージ
- 1日 11時間
- マージ済み PR(30日)
- 11
説明

Please add samples on JSDocs with react, a lot programmers including me need IntelliSense and other benefits like auto-completion and type-checking as well. Migration over to TypeScript is not ideal if you have large code base. Adding a JSDoc comment is the easiest way of getting a lot of TypeScript tooling without configuring any code at all. On top of that vscode already supports it just by turning on in the settings
"javascript.implicitProjectConfig.checkJs": true
It even provides comment template for JavaScript functions when you type/**

That's way I think reactjs docs should provide examples on this
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ファイルやテストは指定されていないため、まず既存の React ドキュメントの例と、リクエストにおける JSDoc および VS Code のコンテキストを確認します。どの例で JSDoc を示すべきかを定義し、その後、ドキュメントに IntelliSense、補完、型チェックの意図された利点を説明する実用的なサンプルが含まれていることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, react
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100