microsoft / microsoft/TypeScript
Handle JSDoc @param with hyphen
オープン
まだ誰も着手していません。
Domain: JSDoc
Experience Enhancement
Suggestion
VS Code Tracked
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 132
説明
TypeScript Version: 2.7.0-dev.20171214
Code
/**
* @param x - Bla
*/
function foo(x) { }
Hover over x
Expected behavior:
Hyphen is ignored in any documentation returned. See JSDoc @param spec: http://usejsdoc.org/tags-param.html
Actual behavior:
Hyphen is returned as part of documentation:
[Trace - 2:58:07 PM] Response received: quickinfo (144). Request took 3 ms. Success: true
Result: {
"kind": "parameter",
"kindModifiers": "",
"start": {
"line": 4,
"offset": 14
},
"end": {
"line": 4,
"offset": 15
},
"displayString": "(parameter) x: any",
"documentation": "- Bla",
"tags": []
}
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Issue に示されている quickinfo hover response で使用される TypeScript JSDoc @param の処理から始めます。サンプルを再現し、ドキュメント文字列がどこで形成されるかを追跡して、返されるドキュメントで区切りのハイフンが省略され、説明が保持されていることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- tooling
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100