Microsoft/TypeScript

Support formatting JSDoc comments

Open

#11 500 ouverte le 10 oct. 2016

Voir sur GitHub
 (2 commentaires) (3 réactions) (0 assignés)TypeScript (6 726 forks)batch import
Domain: JSDocHelp WantedSuggestionVS Code Tracked

Métriques du dépôt

Stars
 (48 455 stars)
Métriques de merge PR
 (Merge moyen 6j 17h) (9 PRs mergées en 30 j)

Description

Formatting:

/**
      *    @param  { Object }    bar 
                */
function foo(bar) { }

Should result in:

/**
 * @param {Object} bar 
 */
function foo(bar) { }

Reported originally in https://github.com/Microsoft/TypeScript/issues/11456

Guide contributeur

Direction de recherche
Étudiez la logique de formatage des commentaires dans le compilateur TypeScript, en particulier comment les commentaires JSDoc sont actuellement traités, et modifiez le visiteur AST approprié pour appliquer une indentation et un espacement corrects.
Stack technique
typescript
Domaine
developer experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65