microsoft / microsoft/TypeScript
Suggestion: Generate doc comments in emitted JS
オープン
まだ誰も着手していません。
Needs Proposal
Suggestion
VS Code Tracked
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR（30日）
- 132
説明
Support some level of automatically generating doc comments for non-TypeScript JavaScript consumers.
Need more details on what exactly people would like to see generated.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ファイル、テスト、エントリポイントが指定されておらず、issue では必要な生成コメントの定義もまだ必要だとされています。まず、JavaScript の利用者に必要なドキュメントコメントと、想定される出力結果を明確にしてください。指定された生成コメントを対象とするスコープの合意とテストがあれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, typescript
- 領域
- compilers, documentation
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 20/100