microsoft / microsoft/TypeScript

Allow reporting errors for unresolved @ link jsdoc tags

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

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

In Discussion Suggestion
主要言語
Go
スター
111k
フォーク
14.4k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

Suggestion

🔍 Search Terms

  • jsdoc
  • @link

⭐ Suggestion

Add an option to report unresolved @link symbols in JSDoc comments.

This can help catch some simple mistakes and also alert the user to cases where our IntelliSense doesn't understand the jsdocs symbol

📃 Motivating Example

/**
 * {@link food} <- Should been an error here
 */
const foo = 12

💻 Use Cases

We'd use this in vscode for both our main codebase and for our vscode.d.ts file.

I imagine this would also be quite useful for maintaining definitely typed

Related issues

  • #15852

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

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

はじめの一歩

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

調査の方向性

動機となった JSDoc の例と関連する issue #15852 から始め、未解決の @link シンボルをどのように診断し、設定可能にすべきかを判断します。説明されている VS Code と宣言ファイルのユースケースを含め、有効なリンクに影響を与えずに未解決のリンクを報告するオプションが実装されれば、作業は完了です。

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

評価

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

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

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