microsoft / microsoft/TypeScript
JSDoc `@private` on constructor without parameters is omitted in declaration files
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 private constructor
🕗 Version & Regression Information
- This is the behavior in every version I tried back through TS 3.8 where JSDoc support was added, and I reviewed the FAQ for entries about JSDoc
⏯ Playground Link
💻 Code
// foo.js
class Foo {
/**
* @private
*/
constructor() {}
}
new Foo()
// Constructor of class 'Foo' is private and only accessible within the class declaration.(2673)
🙁 Actual behavior
Emits the declaration file:
declare class Foo {
}
🙂 Expected behavior
Should emit the declaration file:
declare class Foo {
/**
* @private
*/
private constructor();
}
Additional information about the issue
I ran into this as it was requested that TypeDoc add a new JSDoc tag to work around this issue. This seems wrong since the declaration file doesn't accurately describe the types within the file, but it's also very unfortunate that it results in the loss of any documentation added to the constructor.
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 par la reproduction liée dans TypeScript Playground en utilisant foo.js et comparez le fichier de déclaration généré avec la sortie attendue. Suivez la manière dont le JSDoc @private du constructeur sans paramètre est représenté lors de la génération des déclarations. C'est terminé lorsque le .d.ts généré conserve le constructeur privé et sa documentation sans modifier le comportement d'accès au constructeur signalé.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript, typescript
- Domaine
- compilers
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100