microsoft / microsoft/TypeScript
JSDoc tags not parsed when a type may be present
オープン
まだ誰も着手していません。
Bug
Domain: JSDoc
Help Wanted
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.3k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 132
説明
🔎 Search Terms
jsdoc links missing in possible type position
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about JSDoc
⏯ Playground Link
💻 Code
class C {
}
/**
* @throws {@link C}
*/
function /**/CC() {
}
🙁 Actual behavior
TypeScript does not resolve {@link C}.
Hover on the playground shows:
@throws — {
@link — C}
🙂 Expected behavior
TypeScript should resolve {@link C}
Hover on the playground should show this (or even better rendered links like it does in vscode)
@throws — {@link C }
Additional information about the issue
Originally reported in https://github.com/TypeStrong/typedoc/issues/2993
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
提供された TypeScript Playground のリンクと、@throws {@link C} を含む JSDoc の例から始めます。型が存在する可能性がある場合に JSDoc タグがどのように解析されるかを追跡します。リンクが C に解決され、Playground のホバーに @link と C を分割せずリンクの内容が表示されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- compilers
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100