microsoft / microsoft/TypeScript

JSDoc tag descriptions lose their indentation.

Aperta
#53,576 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Bug Domain: JSDoc Help Wanted
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
1g 19h
PR unite (30g)
117

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Usa la riproduzione JavaScript/JSDoc presente nell’issue in vscode.dev, quindi passa il mouse su foo() e obj.foo per confrontare le descrizioni renderizzate. Analizza il percorso della descrizione dei tag JSDoc coinvolto dall’esempio @property. Il lavoro è completato quando l’indentazione all’interno del fenced code block della proprietà viene preservata come nella descrizione autonoma.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
devtools
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.