reactjs / reactjs/react-docgen
Document TSDoc support
オープン
まだ誰も着手していません。
typescript
- 主要言語
- TypeScript
- スター
- 3.8k
- フォーク
- 316
- 平均マージ
- 5時間 7分
- マージ済み PR（30日）
- 4
説明
Related to #458, but TSDoc (a tool maintained by Miscrosoft) although influenced by JSDoc, has a strictly distinct syntax. For example, @default in JSDOC is @defaultValue in TSDOC. @inheritDoc doesn't have the same semantics, and require an argument in TSDoc... etc.
The full specification is yet to be written, but there is already a very well documented syntax reference here. See https://github.com/microsoft/tsdoc/issues/130 for updates on this specific issue.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず関連する issue #458 とリンク先の TSDoc 構文リファレンスを読み、次に仕様の更新について microsoft/tsdoc#130 を確認します。既存の JSDoc の処理を、TSDoc の独自の構文とセマンティクスと比較します。合意された TSDoc のサポートが文書化され、参照された構文に対して検証されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- documentation, tooling
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100