microsoft / microsoft/TypeScript
JSDoc multi-line properties within Array<Object> syntax parse differently than Object[]
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
TypeScript Version: 3.5.0-dev.20190416
Search Terms:
JSDoc @type @param @arg multi-line type literal Array<>
Code
/**
* @param {Array<Object>} os - has a string and a number
* @param {string} os[].s - the string
* @param {number} os[].n - the number
*/
function f(os) { return os[0].s; }
Expected behavior:
It appears that #17352 implemented this correctly for when the first @param is @param {Object[]} but failed to consider the other syntax to write this in JSDoc: @param {Array<Object>}.
For ease of debugging I am looking at the output of Intellisense when hovering over os in the function. I'd expect the output to look as iti does when @param {Object[]} is used:

Actual behavior:

Playground Link:
Playground Link
Related Issues:
#11597
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンクされた Playground の再現から始め、Array<Object> にホバーしたときの情報を、同等の Object[] 構文の場合と比較します。#17352 で説明されている動作を読み、関連する issue #11597 と比較します。完了条件は、どちらの形式でも os に対して同じ複数行のプロパティ情報が生成されることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, typescript
- 領域
- compilers
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100