microsoft / microsoft/TypeScript

Inherited methods not merging JSDoc comments

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

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

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

説明

Steps to reproduce

class Foo {
   /** foo bar */
   method(): void {}
}

class Bar extends Foo {
   /** @remarks lorem ipsum */
   method(): void {}
}

Behavior with typescript@5.9

Hovering over Bar#method gives:

(method) Bar.method(): void
foo bar
@remarks — lorem ipsum

Behavior with tsgo

Hovering over Bar#method gives:

(method) Bar.method(): void
@remarks — lorem ipsum

Note that the foo bar is gone. I believe that blocks like @remarks being merged is a case not handled by microsoft/typescript-go#2111

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

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

はじめの一歩

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

調査の方向性

まず issue にある TypeScript 5.9 と tsgo の再現例から始め、関連する JSDoc のマージ動作について microsoft/typescript-go#2111 を読んでください。継承されたメソッドのドキュメントの扱いを比較し、補完では foo bar テキストと @remarks ブロックが一貫してマージされるようにします。

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

評価

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

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

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