microsoft / microsoft/TypeScript

JSDoc tag descriptions lose their indentation.

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

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

Bug Domain: JSDoc Help Wanted
主要言語
Go
スター
111k
フォーク
14.4k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

Does this issue occur when all extensions are disabled?: Yes

Version: 1.76.2
Commit: ee2b180d582a7f601fa6ecfdad8d9fd269ab1884
Date: 2023-03-14T17:47:26.641Z
Browser: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36

Steps to Reproduce:

  1. Open vscode.dev
  2. Create a new file and set language mode to JavaScript
  3. Paste the following:
/**
 * This works
 * ```
 * some
 *   indentations
 *     and
 *       some
 *         more
 * ```
 */
function foo() {}

/**
 * @typedef MyObj
 * @property {number} foo This doesn't
 * ```
 * some
 *   indentations
 *     and
 *       some
 *         more
 * ```
 */

const obj = /** @type {MyObj} */ (null);

obj.foo
  1. Hover over foo on the last line.

When hovering over foo() it works fine:
image

But on obj.foo the identation of the code block is lost:
image

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

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

はじめの一歩

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

調査の方向性

vscode.dev で issue 内の JavaScript/JSDoc の再現手順を使い、次に foo()obj.foo にカーソルを合わせて、表示される説明を比較します。@property の例に関係する JSDoc タグの説明パスを調査します。プロパティの fenced code block 内のインデントが、単独の説明と同じように保持されれば完了です。

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

評価

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

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

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