Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Highlight @example jsdoc body as source code

Ouverte
#693 6 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

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

Piste de recherche

Examinez le fichier lié VS Code ExampleJsDoc.injection.tmLanguage.json et la gestion de la grammaire TypeScript/JavaScript du dépôt pour les commentaires JSDoc. Confirmez comment l'injection existante sépare les astérisques initiaux du contenu de la documentation ; le travail est considéré comme terminé lorsque le corps d'un bloc @example reçoit une coloration syntaxique du code source.

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

Description

TS and JS Grammar Extension version: 0.0.47 / latest

Code
For a js doc body such as:

/**
 * @example
 * 1 + 1
 */
const a = 1

We mark the body of the @example block specially but do not actually syntax highlight it. I added an injection grammar in VS Code that does this: https://github.com/Microsoft/vscode/blob/master/extensions/typescript-basics/syntaxes/ExampleJsDoc.injection.tmLanguage.json

May be worth including in the core grammar. Let me know if you agree. The injection grammar will not work as is, we're relying on another injection grammar that handles separating the leading stars of the doc block from the documentation content itself

Langage dominant
TypeScript
Étoiles
471
Forks
149
Aucune PR mergée en 30 j

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

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.

Autres issues de microsoft/TypeScript-TmLanguage

Toutes les issues de microsoft/TypeScript-TmLanguage

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

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