microsoft / microsoft/TypeScript
Declaration emit of private properties should strip jsdoc
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.4k
- Merge moyen
- 1 j 19 h
- PR mergées (30 j)
- 117
Description
🔎 Search Terms
jsdoc dts declaration emit private properties property
🕗 Version & Regression Information
- This is the behavior in every version I tried
⏯ Playground Link
💻 Code
export class Foo {
/** This is a public method. */
public publicMethod() {}
/** This is a private method, and will be stripped in the declaration file. */
private privateMethod() {}
}
🙁 Actual behavior
export declare class Foo {
/** This is a public method. */
publicMethod(): void;
/** This is a private method, and will be stripped in the declaration file. */
private privateMethod;
}
Note the jsdoc on the private method.
🙂 Expected behavior
export declare class Foo {
/** This is a public method. */
publicMethod(): void;
private privateMethod;
}
Additional information about the issue
It sure seems like this info should be stripped; after all, the type information is gone, leaving only a marker to inform child classes.
This causes TypeScript's own dts files to be filled with private method jsdoc. https://github.com/microsoft/TypeScript/pull/57492/files#r1559884318
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez avec le Playground Link et reproduisez l'émission de déclarations présentée dans l'issue. Suivez la gestion par TypeScript de l'émission de déclarations pour les propriétés privées, puis vérifiez que le JSDoc de la propriété privée est omis tandis que le marqueur private reste présent dans la sortie de déclarations générée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- compilers
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 48/100