microsoft / microsoft/TypeScript

Feature Request: Split out JsDoc comments for constructor function when convert function to ES2015 class

Ouverte
#32,492 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Awaiting More Feedback Domain: LS: Refactorings Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

Add ability to convert JsDoc comments in following situation:

/**
 * @class
 * Some constructor description.
 * @classdesc
 * Some class description
 */
function Class() {}

must be converted to

/**
 * Some class description
 */
class Class {
  /**
   * Some constructor description.
   */
  constructor() {}
}

Right now you get following result:

/**
 * @class
 * Some constructor description.
 * @classdesc
 * Some class description
 */
class Class {
  constructor() {}
}

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.

Piste de recherche

Aucun fichier, test ou point d’entrée n’est indiqué. Commencez par localiser la conversion de fonctions en classes ES2015 et son traitement de JsDoc ; le travail est terminé lorsque @classdesc devient le commentaire de la classe, tandis que la description du constructeur devient le commentaire du constructeur, comme indiqué dans les exemples.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, typescript
Domaine
compilers
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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