microsoft / microsoft/TypeScript
Report errors (and quickfixes) for incorrect JSDoc
オープン
まだ誰も着手していません。
Domain: JSDoc
In Discussion
Suggestion
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR（30日）
- 117
説明
TypeScript Version: nightly (2.4.0-dev.20170515)
Code
/**
* @param abcdeg A parameter
*/
function f(abcdefg: number) {
abcdeg;
}
Expected behavior:
Can fix spelling for either abcdeg.
Actual behavior:
Does not work in jsdoc.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
提供された関数例の TypeScript/JSDoc 処理から始め、スペルミスのある @param 名と参照が現在どのように処理されているかを追跡します。これらの不一致に対する診断と quickfix がどこで生成されるかを特定します。例でスペルエラーが報告され、どちらの出現箇所に対しても修正が提示され、両方のケースに対する適切なテストが追加されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100