microsoft / microsoft/TypeScript

Suggestion: Generate doc comments in emitted JS

Ouverte
#10 61 commentaires 111 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Needs Proposal Suggestion VS Code Tracked
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

Support some level of automatically generating doc comments for non-TypeScript JavaScript consumers.

Need more details on what exactly people would like to see generated.

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 nommé, et l’issue indique qu’il faut encore définir les commentaires générés souhaités. Il faut d’abord clarifier quels commentaires de documentation les consommateurs JavaScript nécessitent et quelle est la sortie émise attendue. La tâche est considérée comme terminée lorsqu’un périmètre convenu et des tests couvrant les commentaires générés spécifiés sont définis.

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

Évaluation

Stack technique
javascript, typescript
Domaine
compilers, documentation
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
20/100

Recevez les nouvelles issues par e-mail

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