microsoft / microsoft/TypeScript

Support IntelliSense while writing JSDoc @ link tags

オープン
#44,203 コメント 1 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Experience Enhancement Suggestion
主要言語
Go
スター
111k
フォーク
14.3k
平均マージ
2日 4時間
マージ済み PR(30日)
132

説明

Suggestion

🔍 Search Terms

  • jsdoc
  • @link
  • suggest / suggestion
  • complete / completions
  • IntelliSense

⭐ Suggestion

Enable IntelliSense inside JSDoc @link tags.

As precedent, we already support IntelliSense for @param parameters

📃 Motivating Example

/**
 * {@link } <- Trigger suggest here
 */
const foo = 12

💻 Use Cases

This would help significantly while writing @link tags

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

この issue ではファイルやテストが指定されていません。まず、JSDoc @param パラメーターに対応する既存の IntelliSense パスと、language service の補完エントリポイントを特定し、次に空の {@link } の位置がどのように処理されるかを追跡してください。示されている位置に候補が表示され、JSDoc @link 補完のリグレッションカバレッジが追加されていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript, typescript
領域
developer-experience, tooling
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
42/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。