microsoft / microsoft/TypeScript

JSDoc property description containing "@" character seems to make everything below this as undefined

Ouverte
#39,976 2 commentaires 1 réaction 1 personne assignée Voir sur GitHub

@orta y travaille déjà.

Depuis le 3/11/2020.

Bug Domain: JSDoc
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

This is an issue with TS typings declarations generated from JSDoc and code analysis

TypeScript Version: 3.8.3

Search Terms: jsdoc property at @ description link markdown

Code

/**
 * @typedef SomeTypeDef
 * @property {string} property1
 *   I'm a comment with an [@s](link)
 * @property {boolean} propertyCantBeAccessed
 */

/**
 * @param {SomeTypeDef} s
 */
const f = (s) => {
    s.propertyCantBeAccessed
}

f({
    property1: 'only exists here',
    propertyCantBeAccessed: false
})

Expected behavior:
The property exists and can be accessed

Actual behavior:
Code fails with Property 'propertyCantBeAccessed' does not exist on type 'SomeTypeDef'

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.